Document blobplot taxonomic rank parameters#280
Draft
Mirochill wants to merge 1 commit into
Draft
Conversation
Reviewer's GuideDocuments how to use the catField parameter to control taxonomic rank for blob plot exports and adds concrete family/genus examples to both the command reference and tutorial. Flow diagram for blobtools view export with catField taxonomic rank overrideflowchart LR
A[User runs blobtools view] --> B{catField parameter provided?}
B -- No --> C[Use default BlobDir plot metadata catField]
C --> D[Colour blobs by default taxrule rank
bestsumorder_phylum or existing setting]
B -- Yes --> E[Read catField value
bestsumorder_family or bestsumorder_genus]
E --> F[Override default category field]
F --> G[Render/export blob plot at requested taxonomic rank]
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
This file contains hidden or 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.
Summary
--param catField=<taxrule>_<rank>when exporting blob plots from the command linebestsumorder_phylum,bestsumorder_family, andbestsumorder_genusFixes #277
Validation
git diff --checkSummary by Sourcery
Document how to select taxonomic rank-specific category fields when exporting blob plots from the command line.
Documentation: