README.Rmd

---
output: github_document
---

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

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# skater

<!-- badges: start -->

[![CRAN status](https://www.r-pkg.org/badges/version/skater)](https://CRAN.R-project.org/package=skater)

[![biorXiv](https://img.shields.io/badge/biorXiv-10.1101%2F2021.07.21.453083-red)](https://www.biorxiv.org/content/10.1101/2021.07.21.453083v1)

[![DOI](https://zenodo.org/badge/339462170.svg)](https://zenodo.org/badge/latestdoi/339462170)

[![R-CMD-check-stable](https://github.com/signaturescience/skater/workflows/R-CMD-check-stable/badge.svg)](https://github.com/signaturescience/skater/actions)

[![R-CMD-check-dev](https://github.com/signaturescience/skater/workflows/R-CMD-check-dev/badge.svg)](https://github.com/signaturescience/skater/actions)

<!-- badges: end -->

**S**NP-based **K**inship **A**nalysis **T**esting and **E**valuation: miscellaneous **R** data analysis utilties.

## Installation

Install stable release from CRAN:

``` r
install.packages("skater")
```

Install development version from GitHub:

``` r
remotes::install_github("signaturescience/skater", build_vignettes=TRUE)
```


## Usage

The ["Basic Usage" vignette](https://signaturescience.github.io/skater/articles/basic_usage.html) steps through the primary functionality of the `skater` package:

``` r
vignette("basic_usage", package = "skater")
```

Full documentation: <https://signaturescience.github.io/skater/>.