GATK ESTIMATELIBRARYCOMPLEXITY

https://img.shields.io/github/issues-pr/snakemake/snakemake-wrappers/bio/gatk/estimatelibrarycomplexity?label=version%20update%20pull%20requests

Run gatk EstimateLibraryComplexity

URL: https://gatk.broadinstitute.org/hc/en-us/articles/9570264328603-EstimateLibraryComplexity-Picard-

Example

This wrapper can be used in the following way:

rule gatk_estimate_library_complexity:
    input:
        bam="{sample}.bam",
    output:
        metrics="{sample}.metrics",
    log:
        "logs/{sample}.log",
    params:
        extra="",
        java_opts="",  # optional
    resources:
        mem_mb=1024,
    wrapper:
        "v3.6.0-3-gc8272d7/bio/gatk/estimatelibrarycomplexity"

Note that input, output and log file paths can be chosen freely.

When running with

snakemake --use-conda

the software dependencies will be automatically deployed into an isolated environment before execution.

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.

Software dependencies

  • gatk4=4.5.0.0

  • snakemake-wrapper-utils=0.6.2

Input/Output

Input:

  • SAM/BAM/CRAM file

Output:

  • metrics file

Authors

  • Filipe G. Vieira

Code

__author__ = "Filipe G. Vieira"
__copyright__ = "Copyright 2021, Filipe G. Vieira"
__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)

with tempfile.TemporaryDirectory() as tmpdir:
    shell(
        "gatk --java-options '{java_opts}' EstimateLibraryComplexity"
        " --INPUT {snakemake.input}"
        " {extra}"
        " --TMP_DIR {tmpdir}"
        " --OUTPUT {snakemake.output.metrics}"
        " {log}"
    )