Curated and processed metagenomic data through ExperimentHub
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
R
data-raw
data
inst modifity test-curatedMetagenomicData.R to treat - as _ Apr 26, 2018
man
tests
vignettes
.Rbuildignore updates to build ignore file Oct 3, 2017
.gitignore Update .gitignore Jun 20, 2017
.travis.yml
CONTRIBUTING.md
DESCRIPTION
LICENSE
NAMESPACE
NEWS
README.md Update README.md Nov 17, 2017
appveyor.yml
codecov.yml
curatedMetagenomicData.Rproj

README.md

fa-pencil Support Site Activity fa-building Build Results fa-linux Travis-CI Build Status fa-windows AppVeyor Build Status fa-percent Coverage Status fa-git Subversion Commits

curatedMetagenomicData

curatedMetagenomicData uses Bioconductor's ExperimentHub to distribute taxonomic and metabolic functional profiles and curated metadata for publicly available human microbiome samples generated by shotgun metagenomic sequencing.

Quick Start

Install curatedMetagenomicData through Bioconductor using BiocInstaller and open the package vignette. Microbiome profiles and metadata can be accessed from within R or from the command line.

BiocInstaller::biocLite("curatedMetagenomicData")
browseVignettes("curatedMetagenomicData")

For more extensive information on installing and using curatedMetagenomicData please see https://waldronlab.github.io/curatedMetagenomicData/.

Contributing

Contributions will gladly be accepted provided they fit within the context of the project. Please see CONTRIBUTING.md for information regarding reporting bugs, pull request, adding datasets and other issues.

Copyright and License

curatedMetagenomicData is Free software licensed under the Artistic License 2.0 (copied here as the LICENSE file, verbatim as required by the Perl Foundation). For the purposes of this license, the "Copyright Holders" are the authors of the manuscript (https://www.nature.com/articles/nmeth.4468). In general you may use and re-distribute original and modified versions of the software under very permissive conditions. The appropriate citation information for each dataset can be found by doing experimentData(eset) (where eset is the name of the ExpressionSet class data object), by looking at the man page of the dataset (e.g. ?HMP_2012), or by looking at the reference manual of the development or release version.