diff --git a/conf/modules.config b/conf/modules.config index 715dc71..47ed81e 100644 --- a/conf/modules.config +++ b/conf/modules.config @@ -144,10 +144,10 @@ process { } -if (params.blackListFile != null) { +if (params.blacklist != null) { process { withName: '.*DEEPTOOLS_BAMCOVERAGE.*' { - ext.args = "–blackListFileName ${params.blackListFile}" + ext.args = "–blackListFileName ${params.blacklist}" } } } diff --git a/docs/usage.md b/docs/usage.md index 5cca560..7bf46f3 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -117,11 +117,11 @@ Optionally, the fractions extracted from the same `experimentalID` can be combin ## Reference genome files -The minimum reference genome requirements is the FASTA file, provided with the mandatory parameter `--fasta`, the bwa index will be generated by the pipeline and can be saved for later reuse if the `--save_reference` parameter is passed. The index building step can be quite a time-consuming process and it permits their reuse for future runs of the pipeline to save disk space, if already present it can be passed using the `--bwa_index '/path/to/bwa/index/'` parameter. +The minimum reference genome requirements is the FASTA file, provided with the mandatory parameter `--fasta`, the bwa index will be generated by the pipeline and can be saved for later reuse if the `--save_reference` parameter is passed. The index building step can be quite a time-consuming process and it permits their reuse for future runs of the pipeline to save disk space, if already present it can be passed using the `--bwa '/path/to/bwa/index/'` parameter. ### Blacklist bed files -A blacklist of regions that will be excluded by signal tracks can be provided using the optional parameter `--blackListFile` with full path to a coordinate file in bed format. Blacklist files for several genome builds can be found in the [ENCODE Blacklist Project](https://github.com/Boyle-Lab/Blacklist). +A blacklist of regions that will be excluded by signal tracks can be provided using the optional parameter `--blacklist` with full path to a coordinate file in bed format. Blacklist files for several genome builds can be found in the [ENCODE Blacklist Project](https://github.com/Boyle-Lab/Blacklist). ## Updating the pipeline diff --git a/nextflow.config b/nextflow.config index ded694b..7c4188e 100644 --- a/nextflow.config +++ b/nextflow.config @@ -17,7 +17,7 @@ params { genome = null igenomes_base = 's3://ngi-igenomes/igenomes' igenomes_ignore = true - bwa_index = null + bwa = null save_reference = false //overall analysis options @@ -32,7 +32,7 @@ params { multiqc_methods_description = null // bam generation - blackListFile = null + blacklist = null // Boilerplate options outdir = null diff --git a/nextflow_schema.json b/nextflow_schema.json index dbc2628..79a69ce 100644 --- a/nextflow_schema.json +++ b/nextflow_schema.json @@ -98,7 +98,7 @@ "help_text": "This parameter is *mandatory* if `--genome` is not specified. If you don't have a BWA index available this will be generated for you automatically. Combine with `--save_reference` to save BWA index for future runs.", "fa_icon": "far fa-file-code" }, - "bwa_index": { + "bwa": { "type": "string", "format": "path", "exists": true, @@ -119,7 +119,7 @@ "default": true, "help_text": "Do not load `igenomes.config` when running the pipeline. You may choose this option if you observe clashes between custom parameters and those supplied in `igenomes.config`. You can run `sammyseq` by specifying at least a FASTA genome file." }, - "blackListFile": { + "blacklist": { "type": "string", "format": "file-path", "fa_icon": "fas fa-ban", diff --git a/workflows/sammyseq.nf b/workflows/sammyseq.nf index deb5e15..3bdb52b 100644 --- a/workflows/sammyseq.nf +++ b/workflows/sammyseq.nf @@ -100,7 +100,7 @@ workflow SAMMYSEQ { PREPARE_GENOME (params.fasta, - params.bwa_index) + params.bwa) ch_versions = ch_versions.mix(PREPARE_GENOME.out.versions)