README.Rmd

---
output: github_document
---

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

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

# Reference-based Ancestry INference <img src="man/figures/rain.png" align="right" width="120" />

<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
[![GitHub tag](https://img.shields.io/github/tag/umr1283/rain.svg?label=latest tag&include_prereleases)](https://github.com/umr1283/rain)
[![R build status](https://github.com/umr1283/rain/workflows/R-CMD-check/badge.svg)](https://github.com/umr1283/rain/actions)
<!-- badges: end -->

## Installation

```{r, eval = FALSE}
# Install rain from CRAN:
install.packages("rain")

# Or the the development version from GitHub:
# install.packages("remotes")
remotes::install_github("umr1283/rain")
```

## Overview 

* `estimate_ethnicity()` allows to format VCF files and compute the genomic components (and some figures) for ethnicity using [flashpca](https://github.com/gabraham/flashpca) software
* `pca_report()` allows to compute an analysis report using principal component analysis from [flashpca](https://github.com/gabraham/flashpca) software. 

---

## Getting help

If you encounter a clear bug, please file a minimal reproducible example on [github](https://github.com/umr1283/rain/issues).  
For questions and other discussion, please contact the package maintainer.

## Code of Conduct

Please note that the `rain` project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.