README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r setup, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  message = FALSE,
  warning = FALSE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```
# similR: Similarity and Distance metrics for binary matrices

[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental) 
[![CRAN status](https://www.r-pkg.org/badges/version/similR)](https://cran.r-project.org/package=similR)
[![Travis build status](https://travis-ci.org/muriteams/similR.svg?branch=master)](https://travis-ci.org/muriteams/similR)
[![Build status](https://ci.appveyor.com/api/projects/status/p0xice4ingylud9r?svg=true)](https://ci.appveyor.com/project/gvegayon/similr-adu2u)


The development version from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("USCCANA/similR")
```
## Example

An example from the manual

```{r}
library(similR)

data(powerset03)
 
# We can compute it over the entire set
head(similarity(powerset03, statistic="s14"))

# Or over two pairs
head(similarity(powerset03[[1]], powerset03[[2]], powerset03[[3]], statistic="s14"))

# We can compute multiple distances at the same time
ans <- similarity(powerset03, statistic=c("hamming", "dennis", "jaccard"))
head(ans)

```


Currently, the full list of available statistics is:

```{r}
data("statistics")
statistics
```