Skip to content

Commit

Permalink
feat: Deeptools Alignement seive (#1320)
Browse files Browse the repository at this point in the history
<!-- 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

This PR adds deeptools alignment-sieve to the list of available wrappers

### 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).

---------

Co-authored-by: tdayris <tdayris@gustaveroussy.fr>
Co-authored-by: tdayris <thibault.dayris@gustaveroussy.fr>
Co-authored-by: Johannes Köster <johannes.koester@uni-due.de>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: snakedeploy-bot[bot] <115615832+snakedeploy-bot[bot]@users.noreply.github.com>
Co-authored-by: Felix Mölder <felix.moelder@uni-due.de>
Co-authored-by: Christopher Schröder <christopher.schroeder@tu-dortmund.de>
  • Loading branch information
8 people committed May 3, 2023
1 parent 528c91a commit b7cb7ab
Show file tree
Hide file tree
Showing 7 changed files with 75 additions and 0 deletions.
6 changes: 6 additions & 0 deletions bio/deeptools/alignmentsieve/environment.yaml
@@ -0,0 +1,6 @@
channels:
- conda-forge
- bioconda
- nodefaults
dependencies:
- deeptools =3.5.1
15 changes: 15 additions & 0 deletions bio/deeptools/alignmentsieve/meta.yaml
@@ -0,0 +1,15 @@
name: deeptools alignment-sieve
url: https://deeptools.readthedocs.io/en/develop/content/tools/alignmentSieve.html
description: >
filters/shift alignments in a BAM/CRAM file according the the specified parameters.
It can optionally output to BEDPE format.
authors:
Thibault Dayris
input:
- aln: Path to BAM/CRAM formatted alignments. Bam filesm ust be indexed.
output:
- Path to filtered bam alignments or bedpe intervals.
params:
- extra: Optional arguments for `alignmentSieve.py`
notes: |
Input/output formats are automatically detected.
12 changes: 12 additions & 0 deletions bio/deeptools/alignmentsieve/test/Snakefile
@@ -0,0 +1,12 @@
rule test_deeptools_alignment_sieve:
input:
aln="a.bam",
output:
"filtered.bam",
threads: 1
log:
"logs/deeptools.log",
params:
extra="",
wrapper:
"master/bio/deeptools/alignmentsieve"
Binary file added bio/deeptools/alignmentsieve/test/a.bam
Binary file not shown.
Binary file added bio/deeptools/alignmentsieve/test/a.bam.bai
Binary file not shown.
27 changes: 27 additions & 0 deletions bio/deeptools/alignmentsieve/wrapper.py
@@ -0,0 +1,27 @@
__author__ = "Thibault Dayris"
__copyright__ = "Copyright 2023, Thibault Dayris"
__email__ = "thibault.dayris@gustaveroussy.fr"
__license__ = "MIT"

from snakemake.shell import shell


log = snakemake.log_fmt_shell(stdout=True, stderr=True)
extra = snakemake.params.get("extra", "")

blacklist = snakemake.input.get("blacklist", "")
if blacklist:
extra += f" --blackListFileName {blacklist} "

out_file = snakemake.output[0]
if out_file.endswith(".bed"):
extra += " --BED "

shell(
"alignmentSieve "
"{extra} "
"--numberOfProcessors {snakemake.threads} "
"--bam {snakemake.input.aln} "
"--outFile {out_file} "
"{log} "
)
15 changes: 15 additions & 0 deletions test.py
Expand Up @@ -2231,6 +2231,21 @@ def test_deeptools_computematrix():
)


@skip_if_not_modified
def test_deeptools_alignmentsieve():
run(
"bio/deeptools/alignmentsieve",
[
"snakemake",
"--cores",
"1",
"filtered.bam",
"--use-conda",
"-F",
],
)


@skip_if_not_modified
def test_deeptools_plotheatmap():
run(
Expand Down

0 comments on commit b7cb7ab

Please sign in to comment.