kkonganti@1: // Help text for spades within CPIPES.
kkonganti@1: 
kkonganti@1: def spadesHelp(params) {
kkonganti@1: 
kkonganti@1:     Map tool = [:]
kkonganti@1:     Map toolspecs = [:]
kkonganti@1:     tool.text = [:]
kkonganti@1:     tool.helpparams = [:]
kkonganti@1: 
kkonganti@1:     toolspecs = [
kkonganti@1:         'spades_run': [
kkonganti@1:             clihelp: 'Run SPAdes assembler. Default: ' +
kkonganti@1:                 (params.spades_run ?: false),
kkonganti@1:             cliflag: null,
kkonganti@1:             clivalue: null
kkonganti@1:         ],
kkonganti@1:         'spades_isolate': [
kkonganti@1:             clihelp: 'This flag is highly recommended for high-coverage isolate and ' +
kkonganti@1:                 "multi-cell data. Default: ${params.spades_isolate}",
kkonganti@1:             cliflag: '--isolate',
kkonganti@1:             clivalue: (params.spades_isolate ? ' ' : '')
kkonganti@1:         ], 
kkonganti@1:         'spades_sc': [
kkonganti@1:             clihelp: 'This flag is required for MDA (single-cell) data. ' +
kkonganti@1:                 "Default: ${params.spades_sc}",
kkonganti@1:             cliflag: '--sc',
kkonganti@1:             clivalue: (params.spades_sc ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'spades_meta': [
kkonganti@1:             clihelp: 'This flag is required for metagenomic data. ' +
kkonganti@1:                 "Default: ${params.spades_meta}",
kkonganti@1:             cliflag: '--meta',
kkonganti@1:             clivalue: (params.spades_meta ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'spades_bio': [
kkonganti@1:             clihelp: 'This flag is required for biosytheticSPAdes mode. ' +
kkonganti@1:                 "Default: ${params.spades_bio}",
kkonganti@1:             cliflag: '--bio',
kkonganti@1:             clivalue: (params.spades_bio ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'spades_corona': [
kkonganti@1:             clihelp: 'This flag is required for coronaSPAdes mode. ' +
kkonganti@1:                 "Default: ${params.spades_corona}",
kkonganti@1:             cliflag: '--corona',
kkonganti@1:             clivalue: (params.spades_corona ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'spades_rna': [
kkonganti@1:             clihelp: 'This flag is required for RNA-Seq data. ' +
kkonganti@1:                 "Default: ${params.spades_rna}",
kkonganti@1:             cliflag: '--rna',
kkonganti@1:             clivalue: (params.spades_rna ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'spades_plasmid': [
kkonganti@1:             clihelp: 'Runs plasmidSPAdes pipeline for plasmid detection. ' +
kkonganti@1:                 "Default: ${params.spades_plasmid}",
kkonganti@1:             cliflag: '--plasmid',
kkonganti@1:             clivalue: (params.spades_plasmid ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'spades_metaviral': [
kkonganti@1:             clihelp: 'Runs metaviralSPAdes pipeline for virus detection. ' +
kkonganti@1:                 "Default: ${params.spades_metaviral}",
kkonganti@1:             cliflag: '--metaviral',
kkonganti@1:             clivalue: (params.spades_metaviral ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'spades_metaplasmid': [
kkonganti@1:             clihelp: 'Runs metaplasmidSPAdes pipeline for plasmid detection in ' +
kkonganti@1:                 "metagenomics datasets. Default: ${params.spades_metaplasmid}",
kkonganti@1:             cliflag: '--metaplasmid',
kkonganti@1:             clivalue: (params.spades_metaplasmid ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'spades_rnaviral': [
kkonganti@1:             clihelp: 'This flag enables virus assembly module from RNA-Seq data. ' +
kkonganti@1:                 "Default: ${params.spades_rnaviral}",
kkonganti@1:             cliflag: '--rnaviral',
kkonganti@1:             clivalue: (params.spades_rnaviral ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'spades_iontorrent': [
kkonganti@1:             clihelp: 'This flag is required for IonTorrent data. ' +
kkonganti@1:                 "Default: ${params.spades_iontorrent}",
kkonganti@1:             cliflag: '--iontorrent',
kkonganti@1:             clivalue: (params.spades_iontorrent ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'spades_only_assembler': [
kkonganti@1:             clihelp: 'Runs only the SPAdes assembler module (without read error correction). ' +
kkonganti@1:                 "Default: ${params.spades_only_assembler}",
kkonganti@1:             cliflag: '--only-assembler',
kkonganti@1:             clivalue: (params.spades_only_assembler ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'spades_careful': [
kkonganti@1:             clihelp: 'Tries to reduce the number of mismatches and short indels in the assembly. ' +
kkonganti@1:                 "Default: ${params.spades_careful}",
kkonganti@1:             cliflag: '--careful',
kkonganti@1:             clivalue: (params.spades_careful ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'spades_cov_cutoff': [
kkonganti@1:             clihelp: 'Coverage cutoff value (a positive float number). ' +
kkonganti@1:                 "Default: ${params.spades_cov_cutoff}",
kkonganti@1:             cliflag: '--cov-cutoff',
kkonganti@1:             clivalue: (params.spades_cov_cutoff ?: '')
kkonganti@1:         ],
kkonganti@1:         'spades_k': [
kkonganti@1:             clihelp: 'List of k-mer sizes (must be odd and less than 128). ' +
kkonganti@1:                 "Default: ${params.spades_k}",
kkonganti@1:             cliflag: '-k',
kkonganti@1:             clivalue: (params.spades_k ?: '')
kkonganti@1:         ],
kkonganti@1:         'spades_hmm': [
kkonganti@1:             clihelp: 'Directory with custom hmms that replace the default ones (very rare). ' +
kkonganti@1:                 "Default: ${params.spades_hmm}",
kkonganti@1:             cliflag: '--custom-hmms',
kkonganti@1:             clivalue: (params.spades_hmm ?: '')
kkonganti@1:         ]
kkonganti@1:     ]
kkonganti@1: 
kkonganti@1:     toolspecs.each {
kkonganti@1:         k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@1:         tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@1:     }
kkonganti@1: 
kkonganti@1:     return tool
kkonganti@1: }