Learn R Programming

cuperdec

R package to generate 'Cumulative Percent Decay' curves, with optional filtering functions, for microbial taxonomic profiles.

These curves aim to represent the level of 'endogenous' content of microbiome samples, such as ancient dental calculus, to help to identify samples with low levels of preservation that should be discarded for downstream analysis.

Installation

cuperdec is on CRAN. You can install the package with the usual command

install.packages("cuperdec")

To install the development version for testing, you can run the following

# install.packages("devtools")
devtools::install_github("jfy133/cuperdec")

Documentation

Please see vignettes/cuperdec-intro.Rmd.

Citation

If you use cuperdec, please use the following citation:

Fellows Yates, J. A. et al. (2021) ‘The evolution and changing ecology of the African hominid oral microbiome’, Proceedings of the National Academy of Sciences of the United States of America, 118(20), p. e2021655118. doi: 10.1073/pnas.2021655118.

Acknowledgments

Irina Velsko (@ivelsko), Zandra Fagerness (@ZandraFagernas), and Lena Semerau for testing and bug reports.

Copy Link

Version

Install

install.packages('cuperdec')

Monthly Downloads

222

Version

1.1.0

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

James A. Fellows Yates

Last Published

September 12th, 2021

Functions in cuperdec (1.1.0)

simple_filter

Apply simple percentage filter
calculate_curve

Calculate cumulative decay percent curve
load_map

Load metadata table
load_database

Load database
plot_cuperdec

Plot cumulative percent decay curves
load_taxa_table

Load OTU table
cuperdec_database_ex

Example isolation source database input for cuperdec
hard_burnin_filter

Calculate hard burn-in retain/discard list
cuperdec_taxatable_ex

Example taxon table input for cuperdec
adaptive_burnin_filter

Calculate adaptive burn-in retain/discard list
cuperdec_metadata_ex

Example metadata file input for cuperdec