Add optional abbreviated parameters for the standalone CLI; add some more context to the README #481
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This makes the CLI a bit easier to use if you're in a hurry, since potentially generating a visualization can be as short as:
I also updated the README a bit to document this, and to make it a bit fancier in general. (One of the changes is consistently using hyphens in filenames for some of the early examples. I didn't modify the QIIME 2 tutorial since the filenames there [IIRC] were designed to be consistent with Q2's tutorial files, some of which have underscores instead of hyphens.)
Not all of the parameters in the standalone CLI have short equivalents (e.g.
--filter-extra-sampleswill still have to be written out in full). I think this is reasonable, since arguably part of the rationale for many of these parameters is requiring the user to acknowledge e.g. "yes I recognize that I am asking the program to filter out certain samples right now".