Skip to content

Latest commit

 

History

History
24 lines (16 loc) · 1.23 KB

README.md

File metadata and controls

24 lines (16 loc) · 1.23 KB

tidyamplicons

Overview

Tidyamplicons is an R package for the analysis of amplicon abundance data: counts of amplicon sequences (either clustered in OTUs or exact variants) in samples. The package builds on the tidyverse created by Hadley Wickham: the data are stored in tidy tables where each row is an observation and each column a variable. In addition, the package supplies a set of "verbs": functions that take a tidyamplicons object as first argument and also return a tidyamplicons object.

Installation

Run the following (only install devtools if not yet installed):

# install.packages("devtools")
devtools::install_github("SWittouck/tidyamplicons", ref = "v0.2.1")

Documentation

Documentation is available for most functions but not all, and it is still very preliminary. A vignette is included with a basic explanation on the package design philosophy and an illustration of some common workflows on an example dataset. To make sure the vignette is built when you install the package, install it in the following way:

devtools::install_github(
  "SWittouck/tidyamplicons", ref = "v0.2.1", build_vignettes = TRUE
)