Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add GATK LeftAlignAndTrimVariants (#993)
<!-- Ensure that the PR title follows conventional commit style (<type>: <description>)--> <!-- Possible types are here: https://github.com/commitizen/conventional-commit-types/blob/master/index.json --> ### Description <!-- Add a description of your PR here--> Add GATK LeftAlignAndTrimVariants wrapper ### QC <!-- Make sure that you can tick the boxes below. --> * [x] I confirm that: For all wrappers added by this PR, * there is a test case which covers any introduced changes, * `input:` and `output:` file paths in the resulting rule can be changed arbitrarily, * either the wrapper can only use a single core, or the example rule contains a `threads: x` statement with `x` being a reasonable default, * rule names in the test case are in [snake_case](https://en.wikipedia.org/wiki/Snake_case) and somehow tell what the rule is about or match the tools purpose or name (e.g., `map_reads` for a step that maps reads), * all `environment.yaml` specifications follow [the respective best practices](https://stackoverflow.com/a/64594513/2352071), * wherever possible, command line arguments are inferred and set automatically (e.g. based on file extensions in `input:` or `output:`), * all fields of the example rules in the `Snakefile`s and their entries are explained via comments (`input:`/`output:`/`params:` etc.), * `stderr` and/or `stdout` are logged correctly (`log:`), depending on the wrapped tool, * temporary files are either written to a unique hidden folder in the working directory, or (better) stored where the Python function `tempfile.gettempdir()` points to (see [here](https://docs.python.org/3/library/tempfile.html#tempfile.gettempdir); this also means that using any Python `tempfile` default behavior works), * the `meta.yaml` contains a link to the documentation of the respective tool or command, * `Snakefile`s pass the linting (`snakemake --lint`), * `Snakefile`s are formatted with [snakefmt](https://github.com/snakemake/snakefmt), * Python wrapper scripts are formatted with [black](https://black.readthedocs.io). * Conda environments use a minimal amount of channels, in recommended ordering. E.g. for bioconda, use (conda-forge, bioconda, nodefaults, as conda-forge should have highest priority and defaults channels are usually not needed because most packages are in conda-forge nowadays).
- Loading branch information
1 parent
3e77337
commit 4ec0c91
Showing
9 changed files
with
441 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
channels: | ||
- conda-forge | ||
- bioconda | ||
- nodefaults | ||
dependencies: | ||
- gatk4 =4.3.0.0 | ||
- snakemake-wrapper-utils =0.5.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
name: gatk LeftAlignAndTrimVariants | ||
url: https://gatk.broadinstitute.org/hc/en-us/articles/360037225872-LeftAlignAndTrimVariants | ||
description: | | ||
Run gatk LeftAlignAndTrimVariants | ||
authors: | ||
- Dmitry Bespiatykh | ||
input: | ||
- A variant call set to left-align and trim | ||
output: | ||
- A left-aligned VCF | ||
notes: | | ||
* The `java_opts` param allows for additional arguments to be passed to the java compiler, e.g. `-XX:ParallelGCThreads=10` (not for `-XmX` or `-Djava.io.tmpdir`, since they are handled automatically). | ||
* The `extra` param allows for additional program arguments. |
2 changes: 2 additions & 0 deletions
2
bio/gatk/leftalignandtrimvariants/test/Homo_sapiens_assembly38.chrM.dict
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
@HD VN:1.6 | ||
@SQ SN:chrM LN:16569 M5:c68f52674c9fb33aef52dcf399755519 UR:file:Homo_sapiens_assembly38.chrM.fasta |
238 changes: 238 additions & 0 deletions
238
bio/gatk/leftalignandtrimvariants/test/Homo_sapiens_assembly38.chrM.fasta
Large diffs are not rendered by default.
Oops, something went wrong.
1 change: 1 addition & 0 deletions
1
bio/gatk/leftalignandtrimvariants/test/Homo_sapiens_assembly38.chrM.fasta.fai
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
chrM 16569 122 70 71 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
rule gatk_leftalignandtrimvariants: | ||
input: | ||
vcf="calls/test_split_with_AS_filters.vcf", | ||
ref="Homo_sapiens_assembly38.chrM.fasta", | ||
fai="Homo_sapiens_assembly38.chrM.fasta.fai", | ||
dict="Homo_sapiens_assembly38.chrM.dict", | ||
# intervals="intervals.bed", # optional | ||
output: | ||
vcf="calls/split_multiallelics.vcf", | ||
log: | ||
"logs/gatk/leftalignandtrimvariants.log", | ||
params: | ||
extra="--split-multi-allelics", # optional | ||
java_opts="", # optional | ||
resources: | ||
mem_mb=1024, | ||
wrapper: | ||
"master/bio/gatk/leftalignandtrimvariants" |
121 changes: 121 additions & 0 deletions
121
bio/gatk/leftalignandtrimvariants/test/calls/test_split_with_AS_filters.vcf
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
"""Snakemake wrapper for GATK LeftAlignAndTrimVariants""" | ||
|
||
__author__ = "Dmitry Bespiatykh" | ||
__copyright__ = "Copyright 2023, Dmitry Bespiatykh" | ||
__license__ = "MIT" | ||
|
||
|
||
import tempfile | ||
from snakemake.shell import shell | ||
from snakemake_wrapper_utils.java import get_java_opts | ||
|
||
extra = snakemake.params.get("extra", "") | ||
java_opts = get_java_opts(snakemake) | ||
log = snakemake.log_fmt_shell(stdout=True, stderr=True) | ||
|
||
|
||
intervals = snakemake.input.get("intervals", "") | ||
if not intervals: | ||
intervals = snakemake.params.get("intervals", "") | ||
if intervals: | ||
intervals = "--intervals {}".format(intervals) | ||
|
||
|
||
with tempfile.TemporaryDirectory() as tmpdir: | ||
shell( | ||
"gatk --java-options '{java_opts}' LeftAlignAndTrimVariants" | ||
" --variant {snakemake.input.vcf}" | ||
" --reference {snakemake.input.ref}" | ||
" {intervals}" | ||
" {extra}" | ||
" --tmp-dir {tmpdir}" | ||
" --output {snakemake.output.vcf}" | ||
" {log}" | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters