/zzinflationR

A very small project (maybe future package) that aims to easily dispose of zero-inflation samples. Input data are gene (or Transcript) count tables, generated from RNA sequencing data.

Primary LanguageRGNU General Public License v3.0GPL-3.0

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

# zzinflationR

<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
<!-- badges: end -->

The goal of `zzinflationR` is to easily remove samples with zero inflation, from a collection of gene or transcript count tables. By defining a threshold value as percentage, the user can define the maximum tolerated zero inflation in a given sample, and get a collective data.table as output.

## Installation

You can install the released version of zzinflationR from [CRAN](https://CRAN.R-project.org) with:

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

## Example

This is a basic example which shows you how to solve a common problem:

```{r example}
library(zzinflationR)
## basic example code
```

What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:

```{r cars}
summary(cars)
```

You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date.

You can also embed plots, for example:

```{r pressure, echo = FALSE}
plot(pressure)
```

In that case, don't forget to commit and push the resulting figure files, so they display on GitHub!