Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.71 KB

README.md

File metadata and controls

42 lines (28 loc) · 1.71 KB

R-CMD-check

microbiomeComputations

microbiomeComputations is an R package which provides helper functions for performing common analyses on microbiome data. The results are available as json, or optionally in a data.table. This package is intended to be compliant with the API specified in VEuPathDB/service-eda-compute.

If you have questions or comments of any kind, join us on our Discord Community Server! We'd love to hear from you.

Installation

Use the R package remotes to install microbiomeComputations. From the R command prompt:

remotes::install_github('microbiomeDB/microbiomeComputations')

Usage

# df is a data frame of abundance values with samples as rows. One column should hold the sample id, all other columns are assumed to be taxa
# the 'recordIdColumn' is the name of the column that contains the sample ids.
# 'method' can be 'simpson', 'shannon', or 'evenness'.
dt <- alphaDiv(df, recordIdColumn="entity.SampleID", method='simpson')

Testing

This package uses the testthat package for testing.

Contributing

Pull requests are welcome and should be made to the dev branch.

For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update unit tests as appropriate.

License

Apache 2.0