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%"
)
```

# CopyKit <a href='https://github.com/navinlabcode/copykit'><img src='images/copykit_hexsticker_v2.png' align="right" height="139" /></a>

<!-- badges: start -->
<!-- badges: end -->

## Overview

The goal of **CopyKit** is to help you analyze single cell DNA sequencing datasets for copy number.
For that, CopyKit presents four modules:

 1) Pre-processing
 2) Quality Control
 3) Data Analysis
 4) Visualization

## Installation

You can install the development version of CopyKit from github with:

``` r
devtools::install_github("navinlabcode/copykit")
```

CopyKit requires R version 4.0 or later.

## Documentation

The complete documentation can be found at:
[https://navinlabcode.github.io/CopyKit-UserGuide/](https://navinlabcode.github.io/CopyKit-UserGuide/)

## Issues

CopyKit has not yet been peer-reviewed so please use it with caution. We do our best to provide a bug free software, however CopyKit is in its infancy and some growing pains are expected. Please let us know of any issues and we will be happy to take a look at it. We greatly appreciate suggestions. Please make sure to, if possible, include a reproducible example and the output of your sessionInfo() when opening an issue.

## Logo

Thanks to [Aislyn Schalck](https://github.com/aislyn) for the awesome CopyKit logo design.