
# PopGenHelpR version 1.4.2 <img src="man/figures/PGH_Logo_Outlined.png" align="right" width="145" height = "145"/>

<!-- badges: start -->
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/PopGenHelpR)](https://cran.r-project.org/package=PopGenHelpR)
[![Downloads from the RStudio CRAN
mirror](https://cranlogs.r-pkg.org/badges/PopGenHelpR)](https://cran.r-project.org/package=PopGenHelpR)
[![CRAN/METACRAN](https://img.shields.io/cran/l/PopGenHelpR)](https://opensource.org/licenses/GPL-3.0)
[![R-CMD-check](https://github.com/kfarleigh/PopGenHelpR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/kfarleigh/PopGenHelpR/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

## What is *PopGenHelpR*?
*PopGenHelpR* is an R package designed to estimate commonly used population genomic statistics and to generate publication quality figures. The current version of PopGenHelpR uses vcf, geno (012), and csv files to generate output, however, future implementations will expand the input file type options. Please see the [vignette](https://kfarleigh.github.io/PopGenHelpR/articles/PopGenHelpR_vignette.html) and other articles for examples. 

We plan to continue developing the package to include more functions, feel free to reach out to Keaka Farleigh if you have any suggestions or would like to collaborate. 

### Do you use *PopGenHelpR* in your research or class and want to be kept up to date?
Please email Keaka Farleigh (keakafarleigh@gmail.com) to be informed about any updates or pending changes to *PopGenHelpR*. 


## Installation

You can install *PopGenHelpR* using:

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

You can install the development version of *PopGenHelpR* using devtools:

``` r
devtools::install_github("kfarleigh/PopGenHelpR")
```

## Citing resources used by PopGenHelpR
*PopGenHelpR* leverages previously developed code resources to perform some calculations in the `Heterozygosity` and `Differentiation` functions. Please see the details regarding references for the functions to ensure that you are citing everyone appropriately. 

