[!CAUTION] Maintenance of this repository was moved to microbiomeDB on 28 Feb 2024. Please see the new location for the most recent version.
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 the VEuPathDB EdaComputeService.
Installation
Use the R package remotes to install microbiomeComputations. From the R command prompt:
remotes::install_github('VEuPathDB/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. 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. If making a change that affects the eda-verse, please conduct integration testing if possible.
License
