mirror of
https://github.com/MillironX/taxprofiler.git
synced 2024-11-22 18:09:54 +00:00
Finalise first pass of nextflow json documentation
This commit is contained in:
James Fellows Yates
parent
bdcae4f934
commit
acd0570b4a
1 changed files with 33 additions and 56 deletions
|
|
@ -10,11 +10,7 @@
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"fa_icon": "fas fa-terminal",
|
"fa_icon": "fas fa-terminal",
|
||||||
"description": "Define where the pipeline should find input data and save output data.",
|
"description": "Define where the pipeline should find input data and save output data.",
|
||||||
"required": [
|
"required": ["input", "databases", "outdir"],
|
||||||
"input",
|
|
||||||
"databases",
|
|
||||||
"outdir"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"input": {
|
"input": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
|
|
@ -84,10 +80,7 @@
|
||||||
"shortread_qc_tool": {
|
"shortread_qc_tool": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"default": "fastp",
|
"default": "fastp",
|
||||||
"enum": [
|
"enum": ["fastp", "adapterremoval"],
|
||||||
"fastp",
|
|
||||||
"adapterremoval"
|
|
||||||
],
|
|
||||||
"fa_icon": "fas fa-tools",
|
"fa_icon": "fas fa-tools",
|
||||||
"description": "Specify which tool to use for short-read QC"
|
"description": "Specify which tool to use for short-read QC"
|
||||||
},
|
},
|
||||||
|
|
@ -140,11 +133,7 @@
|
||||||
"shortread_complexityfilter_tool": {
|
"shortread_complexityfilter_tool": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"default": "bbduk",
|
"default": "bbduk",
|
||||||
"enum": [
|
"enum": ["bbduk", "prinseqplusplus", "fastp"],
|
||||||
"bbduk",
|
|
||||||
"prinseqplusplus",
|
|
||||||
"fastp"
|
|
||||||
],
|
|
||||||
"fa_icon": "fas fa-hammer",
|
"fa_icon": "fas fa-hammer",
|
||||||
"description": "Specify which tool to use for complexity filtering"
|
"description": "Specify which tool to use for complexity filtering"
|
||||||
},
|
},
|
||||||
|
|
@ -178,10 +167,7 @@
|
||||||
"shortread_complexityfilter_prinseqplusplus_mode": {
|
"shortread_complexityfilter_prinseqplusplus_mode": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"default": "entropy",
|
"default": "entropy",
|
||||||
"enum": [
|
"enum": ["entropy", "dust"],
|
||||||
"entropy",
|
|
||||||
"dust"
|
|
||||||
],
|
|
||||||
"fa_icon": "fas fa-check-square",
|
"fa_icon": "fas fa-check-square",
|
||||||
"description": "Specify the complexity filter mode for PRINSEQ++"
|
"description": "Specify the complexity filter mode for PRINSEQ++"
|
||||||
},
|
},
|
||||||
|
|
@ -344,7 +330,8 @@
|
||||||
"centrifuge_save_reads": {
|
"centrifuge_save_reads": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"fa_icon": "fas fa-save",
|
"fa_icon": "fas fa-save",
|
||||||
"description": "Turn on saving of Centrifuge-aligned reads"
|
"description": "Turn on saving of Centrifuge-aligned reads",
|
||||||
|
"help_text": "Save mapped (SAM, FASTQ) and unmapped (FASTQ) reads from alignment step of centrifuge in your output results directory.\n\n> Modifies tool parameter(s):\n> centrifuge: `--un-gz`, `--al-gz`, `--un-conc-gz`, `--al-conc-gz`, `--out-fmt`"
|
||||||
},
|
},
|
||||||
"run_diamond": {
|
"run_diamond": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
|
|
@ -354,22 +341,16 @@
|
||||||
"diamond_output_format": {
|
"diamond_output_format": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"default": "tsv",
|
"default": "tsv",
|
||||||
"enum": [
|
"enum": ["blast", "xml", "txt", "daa", "sam", "tsv", "paf"],
|
||||||
"blast",
|
|
||||||
"xml",
|
|
||||||
"txt",
|
|
||||||
"daa",
|
|
||||||
"sam",
|
|
||||||
"tsv",
|
|
||||||
"paf"
|
|
||||||
],
|
|
||||||
"fa_icon": "fas fa-file",
|
"fa_icon": "fas fa-file",
|
||||||
"description": "Specify output format from DIAMOND profiling."
|
"description": "Specify output format from DIAMOND profiling.",
|
||||||
|
"help_text": "DIAMOND can produce output in a number of different formats, you can specify here which to produce.\n\nNote that DIAMOND can only produce one format at a time, and depending on which you pick, some downstream steps may not be executed. For example, selecting `daa` or `sam` will mean you will not get a tabular taxonomic profile as with the other tools.\n\n> Modifies tool parameter(s):\n> - diamond blastx: `--outfmt`"
|
||||||
},
|
},
|
||||||
"diamond_save_reads": {
|
"diamond_save_reads": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"fa_icon": "fas fa-save",
|
"fa_icon": "fas fa-save",
|
||||||
"description": "Turn on saving of DIAMOND-aligned reads. Will override --diamond_output_format and no taxon tables will be generated"
|
"description": "Turn on saving of DIAMOND-aligned reads. Will override --diamond_output_format and no taxon tables will be generated",
|
||||||
|
"help_text": "Save aligned reads in SAM format from alignment step of DIAMOND in your output results directory.\n\nNote this explicitly overrides `--diamond_output_format` to produce the SAM file, and no taxon table will be generated.\n\n> Modifies tool parameter(s):\n> - DIAMOND: `--outfmt`"
|
||||||
},
|
},
|
||||||
"run_kaiju": {
|
"run_kaiju": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
|
|
@ -379,16 +360,10 @@
|
||||||
"kaiju_taxon_rank": {
|
"kaiju_taxon_rank": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"default": "species",
|
"default": "species",
|
||||||
"enum": [
|
"enum": ["phylum", "class", "order", "family", "genus", "species"],
|
||||||
"phylum",
|
|
||||||
"class",
|
|
||||||
"order",
|
|
||||||
"family",
|
|
||||||
"genus",
|
|
||||||
"species"
|
|
||||||
],
|
|
||||||
"fa_icon": "fas fa-tag",
|
"fa_icon": "fas fa-tag",
|
||||||
"description": "Specify taxonomic rank to be displayed in Kaiju taxon table"
|
"description": "Specify taxonomic rank to be displayed in Kaiju taxon table",
|
||||||
|
"help_text": "Specify the taxonomic level(s) to be displayed in the resulting Kaiju taxon table, as generated by the kaiju2table helper tool.\n\nThis can be either a single level (e.g. `species`), or a comma separated list to display the full taxonomic path (e.g. `-l superkingdom,phylum,class,order,family,genus,species.`).\n\n> Modifies tool parameter(s):\n> - kaiju2table: `-l`"
|
||||||
},
|
},
|
||||||
"run_kraken2": {
|
"run_kraken2": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
|
|
@ -398,12 +373,14 @@
|
||||||
"kraken2_save_reads": {
|
"kraken2_save_reads": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"fa_icon": "fas fa-save",
|
"fa_icon": "fas fa-save",
|
||||||
"description": "Turn on saving of Kraken2-aligned reads"
|
"description": "Turn on saving of Kraken2-aligned reads",
|
||||||
|
"help_text": "Save reads that do and do not have a taxonomic classification in your output results directory in FASTQ format.\n\n> Modifies tool parameter(s):\n> - kraken2: `--classified-out` and `--unclassified-out`"
|
||||||
},
|
},
|
||||||
"kraken2_save_readclassification": {
|
"kraken2_save_readclassification": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"fa_icon": "fas fa-save",
|
"fa_icon": "fas fa-save",
|
||||||
"description": "Turn on saving of Kraken2 per-read taxonomic assignment file"
|
"description": "Turn on saving of Kraken2 per-read taxonomic assignment file",
|
||||||
|
"help_text": "Save a text file that contains a list of each read that had a taxonomic assignment, with information on specific taxonomic taxonomic assignment that that read recieved.\n\n> Modifies tool parameter(s):\n> - kraken2: `--output`"
|
||||||
},
|
},
|
||||||
"run_malt": {
|
"run_malt": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
|
|
@ -414,17 +391,20 @@
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"default": "BlastN",
|
"default": "BlastN",
|
||||||
"fa_icon": "fas fa-check-square",
|
"fa_icon": "fas fa-check-square",
|
||||||
"description": "Specify which MALT alignment mode to use"
|
"description": "Specify which MALT alignment mode to use",
|
||||||
|
"help_text": "Specify which version of MALT alignment to use.\n\nBlastN is generally recommended (nucleotide-nucleotide alignment), but particularly for very short reads (such as aDNA), whereas BlastX mode is similar to DIAMOND and will translate the nucleotide to amino acid sequences. Note each type of alignment mode requires different parameters during database construction. Refer to the MALT manual for more information.\n\n> Modifies tool parameter(s):\n> - malt-run: `-mode` "
|
||||||
},
|
},
|
||||||
"malt_save_reads": {
|
"malt_save_reads": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"fa_icon": "fas fa-save",
|
"fa_icon": "fas fa-save",
|
||||||
"description": "Turn on saving of MALT-aligned reads"
|
"description": "Turn on saving of MALT-aligned reads",
|
||||||
|
"help_text": "Turns on saving of MALT aligned reads in SAM format.\n\nRequires `-a` to be specified in your database arguments (see `--databases`).\n\nNote the SAM format produce by MALT is not completely valid, and may not work with downstream tools."
|
||||||
},
|
},
|
||||||
"malt_generate_megansummary": {
|
"malt_generate_megansummary": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"fa_icon": "fas fa-save",
|
"fa_icon": "fas fa-save",
|
||||||
"description": "Turn on generation of MEGAN summary file from MALT results"
|
"description": "Turn on generation of MEGAN summary file from MALT results",
|
||||||
|
"help_text": "Turns on saving of MALT output in an additional MEGAN summary file (`.megan`) that can be loaded into the MEGAN metagenomic exploration tool.\n\nNote this file is generated not directly from MALT but rather then MEGAN utility script `rma2info`.\n\n> Modifies tool parameter(s):\n> - rma2info: `-es`"
|
||||||
},
|
},
|
||||||
"run_metaphlan3": {
|
"run_metaphlan3": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
|
|
@ -448,23 +428,27 @@
|
||||||
"run_profile_standardisation": {
|
"run_profile_standardisation": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"fa_icon": "fas fa-toggle-on",
|
"fa_icon": "fas fa-toggle-on",
|
||||||
"description": "Turn on standardisation of taxon tables across profilers"
|
"description": "Turn on standardisation of taxon tables across profilers",
|
||||||
|
"help_text": "Turns on standardisation of output OTU tables across all tools, each into a TSV format following the following scheme:\n\n|TAXON | SAMPLE_A | SAMPLE_B |\n|-------------|----------------|-----------------|\n| taxon_a | 32 | 123 |\n| taxon_b | 1 | 5 |\n\nThis currently only is generated for mOTUs."
|
||||||
},
|
},
|
||||||
"generate_biom_output": {
|
"generate_biom_output": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"fa_icon": "fas fa-toggle-on",
|
"fa_icon": "fas fa-toggle-on",
|
||||||
"description": "Turn on generation of BIOM output (currently only applies to mOTUs)"
|
"description": "Turn on generation of BIOM output (currently only applies to mOTUs)",
|
||||||
|
"help_text": "Turn on the saving of the taxonomic output in BIOM format (`.biom`) in the results directory of your pipeline run, instead of the default TSV format.\n\nNote this file is from the output of the `motus merge` command.\n\n> Modifies tool parameter(s):\n> - `-B -o`"
|
||||||
},
|
},
|
||||||
"run_krona": {
|
"run_krona": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"fa_icon": "fas fa-toggle-on",
|
"fa_icon": "fas fa-toggle-on",
|
||||||
"description": "Turn on generation of Krona plots for supported profilers"
|
"description": "Turn on generation of Krona plots for supported profilers",
|
||||||
|
"help_text": "Turn on the generation of Krona interactive pie-chart HTMLs for a selection of profilers.\n\nThe tools currently supported are:\n\n- centrifuge\n- kraken2\n- kaiju\n- MALT"
|
||||||
},
|
},
|
||||||
"krona_taxonomy_directory": {
|
"krona_taxonomy_directory": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"default": "None",
|
"default": "None",
|
||||||
"fa_icon": "fas fa-folder-open",
|
"fa_icon": "fas fa-folder-open",
|
||||||
"description": "Specify path to krona taxonomy directories (required for MALT krona plots)"
|
"description": "Specify path to krona taxonomy directories (required for MALT krona plots)",
|
||||||
|
"help_text": "Specify a path to a Krona taxonomy database directory (i.e. a directory containing a krona generated `.tab` file).\n\nThis is only required for generating Krona plots of MALT output.\n\nNote this taxonomy database must be downloaded and generated with the `updateTaxonomy.sh` script from the krona-tools package."
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"fa_icon": "fas fa-chart-line"
|
"fa_icon": "fas fa-chart-line"
|
||||||
|
|
@ -571,14 +555,7 @@
|
||||||
"description": "Method used to save pipeline results to output directory.",
|
"description": "Method used to save pipeline results to output directory.",
|
||||||
"help_text": "The Nextflow `publishDir` option specifies which intermediate files should be saved to the output directory. This option tells the pipeline what method should be used to move these files. See [Nextflow docs](https://www.nextflow.io/docs/latest/process.html#publishdir) for details.",
|
"help_text": "The Nextflow `publishDir` option specifies which intermediate files should be saved to the output directory. This option tells the pipeline what method should be used to move these files. See [Nextflow docs](https://www.nextflow.io/docs/latest/process.html#publishdir) for details.",
|
||||||
"fa_icon": "fas fa-copy",
|
"fa_icon": "fas fa-copy",
|
||||||
"enum": [
|
"enum": ["symlink", "rellink", "link", "copy", "copyNoFollow", "move"],
|
||||||
"symlink",
|
|
||||||
"rellink",
|
|
||||||
"link",
|
|
||||||
"copy",
|
|
||||||
"copyNoFollow",
|
|
||||||
"move"
|
|
||||||
],
|
|
||||||
"hidden": true
|
"hidden": true
|
||||||
},
|
},
|
||||||
"email_on_fail": {
|
"email_on_fail": {
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue