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.

Sign up for GitHub

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

Better docs for taxpasta related flags #573

Merged
merged 1 commit into from
Jan 30, 2025
Merged

Better docs for taxpasta related flags #573

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions nextflow_schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -675,32 +675,32 @@
},
"taxpasta_add_name": {
"type": "boolean",
"description": "Add the taxon name to the output.",
"help_text": "The standard output format of taxpasta is a two-column table including the read counts and the integer taxonomic ID. The taxon name can be added as additional information to the output table in addition to the taxon ID.\n\nModifies tool parameter(s):\n- taxpasta: `--add-name`",
"description": "Add the taxon name to the output. Requires --taxpasta_taxonomy_dir.",
"help_text": "The standard output format of taxpasta is a two-column table including the read counts and the integer taxonomic ID. The taxon name can be added as additional information to the output table in addition to the taxon ID. Requires --taxpasta_taxonomy_dir to be supplied to infer the additional information.\n\nModifies tool parameter(s):\n- taxpasta: `--add-name`",
"fa_icon": "fas fa-tag"
},
"taxpasta_add_rank": {
"type": "boolean",
"description": "Add the taxon rank to the output.",
"help_text": "The standard output format of taxpasta is a two-column table including the read counts and the integer taxonomic ID. The taxon rank of the given taxonomic entry can be added as additional information to the output table.\n\nModifies tool parameter(s):\n- taxpasta: `--add-rank`",
"description": "Add the taxon rank to the output. Requires --taxpasta_taxonomy_dir.",
"help_text": "The standard output format of taxpasta is a two-column table including the read counts and the integer taxonomic ID. The taxon rank of the given taxonomic entry can be added as additional information to the output table. Requires --taxpasta_taxonomy_dir to be supplied to infer the additional information.\n\nModifies tool parameter(s):\n- taxpasta: `--add-rank`",
"fa_icon": "fas fa-sort-amount-down-alt"
},
"taxpasta_add_lineage": {
"type": "boolean",
"description": "Add the taxon's entire name lineage to the output.",
"help_text": "\nThe standard output format of taxpasta is a two-column table including the read counts and the integer taxonomic ID. The taxon's entire taxonomic lineage with the taxon names separated by semi-colons can be added as additional information to the output table.\n\nModifies tool parameter(s):\n- taxpasta: `--add-lineage`\n",
"description": "Add the taxon's entire name lineage to the output. Requires --taxpasta_taxonomy_dir.",
"help_text": "\nThe standard output format of taxpasta is a two-column table including the read counts and the integer taxonomic ID. The taxon's entire taxonomic lineage with the taxon names separated by semi-colons can be added as additional information to the output table. Requires --taxpasta_taxonomy_dir to be supplied to infer the additional information.\n\nModifies tool parameter(s):\n- taxpasta: `--add-lineage`\n",
"fa_icon": "fas fa-link"
},
"taxpasta_add_idlineage": {
"type": "boolean",
"description": "Add the taxon's entire ID lineage to the output.",
"help_text": "\nThe standard output format of taxpasta is a two-column table including the read counts and the integer taxonomic ID. The taxon's entire taxonomic lineage with the taxon identifiers separated by semi-colons can be added as additional information to the output table.\n\nModifies tool parameter(s):\n- taxpasta: `--add-id-lineage`\n",
"description": "Add the taxon's entire ID lineage to the output. Requires --taxpasta_taxonomy_dir.",
"help_text": "\nThe standard output format of taxpasta is a two-column table including the read counts and the integer taxonomic ID. The taxon's entire taxonomic lineage with the taxon identifiers separated by semi-colons can be added as additional information to the output table. Requires --taxpasta_taxonomy_dir to be supplied to infer the additional information.\n\nModifies tool parameter(s):\n- taxpasta: `--add-id-lineage`\n",
"fa_icon": "fas fa-link"
},
"taxpasta_add_ranklineage": {
"type": "boolean",
"description": "Add the taxon's entire rank lineage to the output.",
"help_text": "\nThe standard output format of taxpasta is a two-column table including the read counts and the integer taxonomic ID. The taxonomic ranks categories of the taxon's entire lineage separated by semi-colons can be added as additional information to the output table. This complements `--taxpasta_add_lineage` by telling you which taxonomic rank level each entry in the lineage refers to.\n\nModifies tool parameter(s):\n- taxpasta: `--add-rank-lineage`\n",
"description": "Add the taxon's entire rank lineage to the output. Requires --taxpasta_taxonomy_dir.",
"help_text": "\nThe standard output format of taxpasta is a two-column table including the read counts and the integer taxonomic ID. The taxonomic ranks categories of the taxon's entire lineage separated by semi-colons can be added as additional information to the output table. This complements `--taxpasta_add_lineage` by telling you which taxonomic rank level each entry in the lineage refers to. Requires --taxpasta_taxonomy_dir to be supplied to infer the additional information.\n\nModifies tool parameter(s):\n- taxpasta: `--add-rank-lineage`\n",
"fa_icon": "fas fa-link"
},
"taxpasta_ignore_errors": {
Expand Down