Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ex: adds usage examples for Hacktoberfest #49

Merged
merged 5 commits into from
Nov 30, 2022

Conversation

ChrisKeefe
Copy link
Contributor

@ChrisKeefe ChrisKeefe commented Oct 28, 2022

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
Copy link
Contributor Author

ChrisKeefe commented Oct 28, 2022

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

@ChrisKeefe ChrisKeefe changed the title Adds basic tabuate usage example ex: adds usage examples for Hacktoberfest Oct 28, 2022
@lizgehret lizgehret self-assigned this Nov 30, 2022
@lizgehret lizgehret merged commit 9495ac1 into qiime2:master Nov 30, 2022
@ebolyen ebolyen mentioned this pull request Jan 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants