diff --git a/conf/modules.config b/conf/modules.config index 263bca3..a3cb66a 100644 --- a/conf/modules.config +++ b/conf/modules.config @@ -547,6 +547,10 @@ process { [ "-p ${meta.tool} -o ${meta.tool}_${meta.id}.${params.standardisation_taxpasta_format}", params.taxpasta_taxonomy_dir ? "--taxonomy ${params.taxpasta_taxonomy_dir}" : "", + params.taxpasta_add_name ? "--add-name" : "", + params.taxpasta_add_rank ? "--add-rank" : "", + params.taxpasta_add_lineage ? "--add-lineage" : "", + params.taxpasta_add_idlineage ? "--add-id-lineage" : "", ].join(' ').trim() } publishDir = [ diff --git a/docs/output.md b/docs/output.md index d34d597..b944299 100644 --- a/docs/output.md +++ b/docs/output.md @@ -449,7 +449,7 @@ The resulting HTML files can be loaded into your web browser for exploration. Ea -By enabling the parameter `--taxonomy` and giving the path to a directory containing taxdump files, the taxon name, the taxon rank and the taxon's entire lineage can be added in the output. Those should be configured through `ext.args` by respectively using the parameters `--add-name`, `--add-rank` and `--add-lineage`. +By enabling the parameter `--taxonomy` and giving the path to a directory containing taxdump files, the taxon name, the taxon rank, the taxon's entire lineage including taxon names and the taxon's entire lineage including taxon identifiers can be added in the output. Those should be configured through `ext.args` by respectively using the parameters `--add-name`, `--add-rank`, `--add-lineage` and `--add-id-lineage`. These files will likely be the most useful files for the comparison of differences in classification between different tools or building consensuses, with the caveat they have slightly less information than the actual output from each tool (which may have non-standard information e.g. taxonomic rank, percentage of hits, abundance estimations). diff --git a/nextflow.config b/nextflow.config index 79f1d71..fc78904 100644 --- a/nextflow.config +++ b/nextflow.config @@ -158,6 +158,10 @@ params { run_profile_standardisation = false standardisation_taxpasta_format = 'tsv' taxpasta_taxonomy_dir = false + taxpasta_add_name = false + taxpasta_add_rank = false + taxpasta_add_lineage = false + taxpasta_add_idlineage = false standardisation_motus_generatebiom = false } diff --git a/nextflow_schema.json b/nextflow_schema.json index 303ab5c..4614dd9 100644 --- a/nextflow_schema.json +++ b/nextflow_schema.json @@ -521,6 +521,28 @@ "type": "boolean", "description": "The path to a directory containing taxdump files.", "help_text": "At least nodes.dmp and names.dmp are required. A merged.dmp file is optional." + }, + "taxpasta_add_name": { + "type": "string", + "default": "false", + "description": "Add the taxon name to the output." + }, + "taxpasta_add_rank": { + "type": "string", + "default": "false", + "description": "Add the taxon rank to the output." + }, + "taxpasta_add_lineage": { + "type": "string", + "default": "false", + "description": "Add the taxon's entire lineage to the output.", + "help_text": "These are taxon names separated by semi-colons. " + }, + "taxpasta_add_idlineage": { + "type": "string", + "default": "false", + "description": "Add the taxon's entire lineage to the output.", + "help_text": "These are taxon identifiers separated by semi-colons. " } }, "fa_icon": "fas fa-chart-line"