<p align="center">

<img src="man/figures/logo.png" alt="SNPkit logo" width="200"/>

</p>

# SNPkit

`SNPkit` is an R package designed for manipulation, organization, and analysis of genotypic data, with a strong focus on integration with tools such as **FImpute** and **PLINK**.

It provides robust S4-based data structures for storing genotypes and marker maps, along with functions to combine different genotype panels, summarize data, and prepare files for imputation and selection pipelines.

------------------------------------------------------------------------

## 📦 Installation

To install directly from GitHub, use the `devtools` package:

``` r
# Install devtools if not already installed
install.packages("devtools")

# Install SNPkit from GitHub
devtools::install_github("viniciusjunqueira/SNPkit")
```

------------------------------------------------------------------------

## 📖 Documentation

The full package website with detailed function reference and vignettes is available at:

-   [SNPkit site](https://viniciusjunqueira.github.io/SNPkit/)

Key pages:

-   [Reference index](https://viniciusjunqueira.github.io/SNPkit/reference/index.html)
-   [Vignettes and Tutorials](https://viniciusjunqueira.github.io/SNPkit/articles/)

------------------------------------------------------------------------

## 📄 License

SNPkit is licensed under the [GPL-3](https://www.gnu.org/licenses/gpl-3.0.html) license.

[![pkgdown](https://img.shields.io/badge/docs-pkgdown-blue.svg)](https://viniciusjunqueira.github.io/SNPkit/) [![GitHub issues](https://img.shields.io/github/issues/viniciusjunqueira/SNPkit)](https://github.com/viniciusjunqueira/SNPkit/issues)
