1
0
Fork 0
mirror of https://github.com/MillironX/taxprofiler.git synced 2024-11-22 09:19:54 +00:00

docs: improve description of shortread_qc_includeunmerged

This commit is contained in:
Moritz E. Beber 2022-12-04 21:53:38 +01:00
parent 4529e7e545
commit b2088bcbb3

View file

@ -128,8 +128,8 @@
"shortread_qc_includeunmerged": { "shortread_qc_includeunmerged": {
"type": "boolean", "type": "boolean",
"fa_icon": "far fa-times-circle", "fa_icon": "far fa-times-circle",
"description": "Include unmerged reads from paired-end merging in the downstream processing", "description": "Include unmerged reads from paired-end merging in the downstream analysis",
"help_text": "Turns on the inclusion of unmerged reads in resulting processing FASTQ file of paired-end sequencing data when using `fastp`.\n\nExcluding unmerged reads can be useful in cases where you prefer to have very short reads (e.g. aDNA), thus excluding longer-reads or possibly faulty reads where one of the pair was discarded.\n\n> Modifies tool parameter(s):\n> - adds option `--include_unmerged`\n" "help_text": "Turns on the inclusion of unmerged reads in resulting FASTQ file from merging paired-end sequencing data when using `fastp` and/or `AdapterRemoval`. For `fastp` this means the unmerged read pairs are directly included in the output FASTQ file. For `AdapterRemoval`, additional output files containing unmerged reads are all concatenated into one file by the workflow.\n\nExcluding unmerged reads can be useful in cases where you prefer to have very short reads (e.g. aDNA), thus excluding longer-reads or possibly faulty reads where one of the pair was discarded.\n\n> Adds `fastp` option: `--include_unmerged`\n"
}, },
"shortread_qc_minlength": { "shortread_qc_minlength": {
"type": "integer", "type": "integer",