search

qiime2 / q2-metadata

BSD 3-Clause "New" or "Revised" License
3 stars 17 forks source link

ex: adds usage examples for Hacktoberfest #49

Closed ChrisKeefe closed 1 year ago

ChrisKeefe commented 1 year ago

This PR is part of our 2022 Hacktoberfest team-wide sprint to add usage examples to all Actions in each of our core distribution plugins. The Actions examples have been added for are as follows:

tabulate

NOTE: tabulate should get an additional example for merging multiple metadata files Edit: multiple files example finished, will push when wifi allows

ChrisKeefe commented 1 year ago

Tests clean locally, renders in CLI like this:

Examples:
  # ### example: basic tabulate usage
  qiime metadata tabulate \
    --m-input-file demux-stats.qza \
    --o-visualization demux-stats-viz.qzv

  # ### example: tabulate multiple files
  # Multiple metadata files or artifacts viewed as metadata can be merged to
  # make one tabular visualization. This one displays only 25 metadata rows
  # per page.
  qiime metadata tabulate \
    --m-input-file sample-metadata.tsv faith-pd-vector.qza \
    --p-page-size 25 \
    --o-visualization demux-stats-viz.qzv