Skip to content

Commit

Permalink
bwa and blacklist parameters names changes
Browse files Browse the repository at this point in the history
  • Loading branch information
lucidif committed Nov 20, 2023
1 parent 2604d5b commit 83d199d
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions conf/modules.config
Original file line number Diff line number Diff line change
Expand Up @@ -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}"
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions nextflow.config
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -32,7 +32,7 @@ params {
multiqc_methods_description = null

// bam generation
blackListFile = null
blacklist = null

// Boilerplate options
outdir = null
Expand Down
4 changes: 2 additions & 2 deletions nextflow_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion workflows/sammyseq.nf
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ workflow SAMMYSEQ {


PREPARE_GENOME (params.fasta,
params.bwa_index)
params.bwa)

ch_versions = ch_versions.mix(PREPARE_GENOME.out.versions)

Expand Down

0 comments on commit 83d199d

Please sign in to comment.