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

add parameter --skip_variant_calling #169

Merged
merged 8 commits into from
Oct 15, 2024
Merged
Show file tree
Hide file tree
Changes from all 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 @@ -45,7 +45,7 @@ jobs:
profile: "singularity"
parameters:
- "docker"
- "docker --skip_subsample_region true --skip_downsample true --skip_build_tracks true --skip_stringtie true --skip_vep true --skip_drop_ae true --skip_drop_as true"
- "docker --skip_subsample_region true --skip_downsample true --skip_build_tracks true --skip_stringtie true --skip_vep true --skip_drop_ae true --skip_drop_as true --skip_variant_calling true"
steps:
- name: Check out pipeline code
uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4
Expand Down
2 changes: 1 addition & 1 deletion .nf-core.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ lint:
- docs/images/nf-core-tomte_logo_light.png
- docs/images/nf-core-tomte_logo_dark.png
- docs/images/tomte_logo.eps
- docs/images/tomte_pipeline_metromap.eps
- docs/images/tomte_pipeline_metromap.svg
- docs/images/tomte_pipeline_metromap.png
- conf/modules.config
- .github/ISSUE_TEMPLATE/config.yml
Expand Down
20 changes: 11 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### `Added`

- Functionality to create DROP databases and to add samples to existing ones [#147](https://github.com/genomic-medicine-sweden/tomte/pull/147)
- A switch `--skip_variant_calling` for variant calling [#169](https://github.com/genomic-medicine-sweden/tomte/pull/169)

### `Fixed`

### `Parameters`

| Old parameter | New parameter |
| -------------------------------- | ------------------- |
| `--max_cpus` | |
| `--max_memory` | |
| `--max_time` | |
| `--validationShowHiddenParams` | |
| `--validationSkipDuplicateCheck` | |
| `--validationS3PathCheck` | |
| `--monochromeLogs` | `--monochrome_logs` |
| Old parameter | New parameter |
| -------------------------------- | ------------------------ |
| `--max_cpus` | |
| `--max_memory` | |
| `--max_time` | |
| `--validationShowHiddenParams` | |
| `--validationSkipDuplicateCheck` | |
| `--validationS3PathCheck` | |
| `--monochromeLogs` | `--monochrome_logs` |
| | `--skip_variant_calling` |

### `Changed`

Expand Down
3 changes: 2 additions & 1 deletion conf/modules/call_variants.config
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

process {
withName: '.*CALL_VARIANTS.*' {
ext.when = { (!params.skip_variant_calling) }
publishDir = [
enabled: false,
]
Expand Down Expand Up @@ -60,7 +61,7 @@ process {
saveAs: { filename -> filename.equals('versions.yml') ? null : filename },
]
}
withName: '.*CALL_VARIANTS:SPLIT_MULTIALLELICS' {
withName: '.*CALL_VARIANTS:SPLIT_MULTIALLELICS' {
ext.prefix = { "${meta.id}_norm" }
ext.args = { '--output-type z --multiallelics -both --write-index=tbi' }
}
Expand Down
9,341 changes: 0 additions & 9,341 deletions docs/images/tomte_pipeline_metromap.eps

This file was deleted.

Binary file modified docs/images/tomte_pipeline_metromap.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1,050 changes: 1,050 additions & 0 deletions docs/images/tomte_pipeline_metromap.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 4 additions & 2 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,9 +190,11 @@ The mandatory and optional parameters for each category are tabulated below.
| --------- | -------------------------------- |
| | variant_caller<sup>1</sup> |
| | bcftools_caller_mode<sup>2</sup> |
| | skip_variant_calling<sup>3</sup> |

<sup>1</sup> If it is not provided by the user, the default value is bcftools<br />
<sup>2</sup> If it is not provided by the user, the default value is multiallelic
<sup>2</sup> If it is not provided by the user, the default value is multiallelic<br />
<sup>3</sup> If it is not provided by the user, the default value is false

#### 5. SNV annotation (ensembl VEP)

Expand Down Expand Up @@ -284,7 +286,7 @@ To build your own database you will need at least 50 for aberrant expression, if
- `--skip_drop_ae false` if you want to get a database for aberrant expression
- `--skip_subsample_region false` if you have sequenced any material with overrepresented regions (such as hemoglobin in whole blood) we recommend to remove it by setting this parameter to false and providing a bed with the overrepresented region with `--subsample_bed`
- `--skip_downsample false` if you have very deeply sequenced samples, we recommend to downsample, the default is 60M read pairs
- `--skip_build_tracks true`, `--skip_stringtie true`, `--skip_vep true` as most users will be interested in getting the database rather than other downstream results
- `--skip_build_tracks true`, `--skip_stringtie true`, `--skip_variant_calling`, `--skip_vep true` as most users will be interested in getting the database rather than other downstream results

Running DROP with many samples requires a lot of time and a lot of memory, that is why we recommend to subsample overrepresented regions and downsample if you have deeply sequenced samples. If your run fails for either of this reasons, try to relaunch it from the work directory where DROP was run so that DROP continues from the point where it failed (if you restart the pipeline with `-resume` it will begin from the start and it will likely fail in the same way).

Expand Down
1 change: 1 addition & 0 deletions nextflow.config
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ params {
save_mapped_as_cram = true

// Variant calling
skip_variant_calling = false
variant_caller = 'bcftools'
bcftools_caller_mode = 'multiallelic'
skip_build_tracks = false
Expand Down
6 changes: 6 additions & 0 deletions nextflow_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,12 @@
"enum": ["consensus", "multiallelic"],
"help_text": "Bcftools call can eitherbe run in multiallelic mode or in consensus mode. In consensus mode a p-value threshold of 0.01 is applied."
},
"skip_variant_calling": {
"type": "boolean",
"default": false,
"description": "Skip variant calling for all samples.",
"fa_icon": "fas fa-toggle-off"
},
"skip_build_tracks": {
"type": "boolean",
"default": false,
Expand Down
Loading