Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Interface to kmer size for pseudoaligners #1144

Merged
merged 10 commits into from
Jan 3, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
matrix:
NXF_VER:
- "23.04.0"
- "latest-everything"
#- "latest-everything"
steps:
- name: Check out pipeline code
uses: actions/checkout@v4
Expand Down
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- [PR #1135](https://github.com/nf-core/rnaseq/pull/1135) - Update [action-tower-launch](https://github.com/marketplace/actions/action-tower-launch) to v2 which supports more variable handling.
- [PR #1138](https://github.com/nf-core/rnaseq/pull/1138) - Updates FASTQC and UMITOOLS modules and their dependencies which have had their version string extraction commands updated ([#1103](https://github.com/nf-core/rnaseq/issues/1103))
- Update Rseqc and Fastp modules to print STDERR to screen and file.
- [PR #1141](https://github.com/nf-core/rnaseq/pull/1141) - Important! Template update for nf-core/tools v2.11
- [PR #1144](https://github.com/nf-core/rnaseq/pull/1144) - Interface to kmer size for pseudoaligners
pinin4fjords marked this conversation as resolved.
Show resolved Hide resolved

### Software dependencies

Expand Down
7 changes: 5 additions & 2 deletions conf/modules.config
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,10 @@ process {
}

withName: 'SALMON_INDEX' {
ext.args = params.gencode ? '--gencode' : ''
ext.args = { [
params.gencode ? '--gencode' : '',
params.pseudo_aligner_kmer_size ? "-k ${params.pseudo_aligner_kmer_size}": ''
].join(' ').trim() }
publishDir = [
path: { "${params.outdir}/genome/index" },
mode: params.publish_dir_mode,
Expand All @@ -84,7 +87,7 @@ process {
}

withName: 'KALLISTO_INDEX' {
ext.args = { params.gencode ? '--gencode' : '' }
ext.args = params.pseudo_aligner_kmer_size ? "-k ${params.pseudo_aligner_kmer_size}" : ''
publishDir = [
path: { "${params.outdir}/genome/index" },
mode: params.publish_dir_mode,
Expand Down
1 change: 1 addition & 0 deletions nextflow.config
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ params {
// Alignment
aligner = 'star_salmon'
pseudo_aligner = null
pseudo_aligner_kmer_size = 31
seq_center = null
bam_csi_index = false
star_ignore_sjdbgtf = false
Expand Down
9 changes: 8 additions & 1 deletion nextflow_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -361,6 +361,13 @@
"fa_icon": "fas fa-hamburger",
"enum": ["salmon", "kallisto"]
},
"pseudo_aligner_kmer_size": {
"type": "integer",
"default": 31,
"description": "Kmer length passed to indexing step of pseudoaligners",
"help_text": "Failure to set a good kmer size could cause issues with quantification with Kallisto or Salmon. This is mostly an issue for short reads (<50bp), where the default kmer size of 31 is an problem.",
"fa_icon": "fas fa-ruler-horizontal"
},
"bam_csi_index": {
"type": "boolean",
"description": "Create a CSI index for BAM files instead of the traditional BAI index. This will be required for genomes with larger chromosome sizes.",
Expand Down Expand Up @@ -397,7 +404,7 @@
},
"min_mapped_reads": {
"type": "number",
"default": 5.0,
"default": 5,
"fa_icon": "fas fa-percentage",
"description": "Minimum percentage of uniquely mapped reads below which samples are removed from further processing.",
"help_text": "Some downstream steps in the pipeline will fail if this threshold is too low."
Expand Down
Loading