Skip to content

Commit

Permalink
feat: gatk CallCopyRatioSegments (#1323)
Browse files Browse the repository at this point in the history
### Description

gatk CallCopyRationSegments wrapper 

### QC
<!-- Make sure that you can tick the boxes below. -->

* [ ] 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
Smeds committed May 3, 2023
1 parent ee55de4 commit 528c91a
Show file tree
Hide file tree
Showing 6 changed files with 85 additions and 0 deletions.
7 changes: 7 additions & 0 deletions bio/gatk/callcopyratiosegments/environment.yaml
@@ -0,0 +1,7 @@
channels:
- conda-forge
- bioconda
- nodefaults
dependencies:
- gatk4 =4.4.0.0
- snakemake-wrapper-utils =0.5.3
14 changes: 14 additions & 0 deletions bio/gatk/callcopyratiosegments/meta.yaml
@@ -0,0 +1,14 @@
name: gatk CallCopyRationSegments
url: https://gatk.broadinstitute.org/hc/en-us/articles/13832751795227-CallCopyRatioSegments
description: |
Calls copy-ratio segments as amplified, deleted, or copy-number neutral
authors:
- Patrik Smeds
input:
- copy_ratio_seg: cr.seq file from ModelSegments
output:
- copy_ratio_seg: called copy ratio segments file
- igv_seg: CBS formatted igv.seg file, optional
params:
- 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).
- extra: param allows for additional program arguments.
16 changes: 16 additions & 0 deletions bio/gatk/callcopyratiosegments/test/Snakefile
@@ -0,0 +1,16 @@
rule call_copy_ratio_segments:
input:
copy_ratio_seg="a.cr.seg",
output:
called_copy_ratio_seg="a.called.seg",
igv_seg="a.called.igv.seg",
log:
"logs/gatk/call_copy_ratio_segments.log",
params:
#prefix="a.den.test",
extra="", # optional
java_opts="", # optional
resources:
mem_mb=1024,
wrapper:
"master/bio/gatk/callcopyratiosegments"
6 changes: 6 additions & 0 deletions bio/gatk/callcopyratiosegments/test/a.cr.seg
@@ -0,0 +1,6 @@
@HD VN:1.6
@SQ SN:ref LN:45
@SQ SN:ref2 LN:40
@RG ID:GATKCopyNumber SM:mysample
CONTIG START END NUM_POINTS_COPY_RATIO MEAN_LOG2_COPY_RATIO
ref2 1 30 1 0.000000
34 changes: 34 additions & 0 deletions bio/gatk/callcopyratiosegments/wrapper.py
@@ -0,0 +1,34 @@
__author__ = "Patrik Smeds"
__copyright__ = "Copyright 2023, Patrik Smed"
__email__ = "patrik.smeds@gmail.com"
__license__ = "MIT"

import os
import tempfile
from snakemake.shell import shell
from snakemake_wrapper_utils.java import get_java_opts


input_copy_ratio_seg = snakemake.input.copy_ratio_seg

called_copy_ratio_seg = snakemake.output.called_copy_ratio_seg

extra = snakemake.params.get("extra", "")
java_opts = get_java_opts(snakemake)

log = snakemake.log_fmt_shell(stdout=True, stderr=True)

with tempfile.TemporaryDirectory() as tmpdir:
outputfile_call = os.path.join(tmpdir, "temp.seq")
outputfile_igv = os.path.join(tmpdir, "temp.igv.seg")
shell(
"gatk --java-options '{java_opts}' CallCopyRatioSegments"
" -I {input_copy_ratio_seg}"
" -O {outputfile_call}"
" --tmp-dir {tmpdir}"
" {extra}"
" {log}"
)
shell("cp {outputfile_call} {called_copy_ratio_seg}")
if snakemake.output.get("igv_seg", None):
shell("cp {outputfile_igv} {snakemake.output.igv_seg}")
8 changes: 8 additions & 0 deletions test.py
Expand Up @@ -3903,6 +3903,14 @@ def test_vcftoolsfilter():
)


@skip_if_not_modified
def test_gatk_callcopyrationsegments():
run(
"bio/gatk/callcopyratiosegments",
["snakemake", "--cores", "1", "a.called.seg", "--use-conda", "-F"],
)


@skip_if_not_modified
def test_gatk_scatterintervalsbyns():
run(
Expand Down

0 comments on commit 528c91a

Please sign in to comment.