Quick Start

This package checks metadata curation for curatedMetagenomicData. To use it:

  1. Look at the template and already curated files to see what curated files should look like.
  2. Place a tab-separated file ending in "_metadata.tsv" in a directory under inst/curation. Commit and create a pull request. Or if you don’t like git, use Github.com’s “Upload Files” button to upload to create a pull request without the need to use git.
  3. Does the new dataset pass all checks? It takes 3-4 minutes for the check to be completed (TODO: add overall badge)
  4. See the detailed syntax-checking report.

If you don’t want to wait for GitHub Actions to finish checking, you can check on your own computer:

BiocManager::install("waldronlab/curatedMetagenomicDataCuration", build_vignettes=TRUE)
browseVignettes("curatedMetagenomicDataCuration")

More complete introduction

The complete reference for curators is provided at this page’s wiki.