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

feat: add ragtag wrapper #1397

Merged
merged 31 commits into from Jun 7, 2023
Merged

Conversation

currocam
Copy link
Contributor

@currocam currocam commented May 26, 2023

Description

Add RagTag wrappers.
https://github.com/malonge/RagTag/tree/master

Some test files are not small, but the tool requires alignments of a certain length not to fail. It seems more reasonable to me not to change the test case to use unrealistic parameters and add some test files as small as possible.

QC

  • 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 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,
  • 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 Snakefiles 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; 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,
  • Snakefiles pass the linting (snakemake --lint),
  • Snakefiles are formatted with snakefmt,
  • Python wrapper scripts are formatted with black.
  • 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).

currocam and others added 6 commits May 27, 2023 07:57
Co-authored-by: Filipe G. Vieira <1151762+fgvieira@users.noreply.github.com>
Co-authored-by: Filipe G. Vieira <1151762+fgvieira@users.noreply.github.com>
Co-authored-by: Filipe G. Vieira <1151762+fgvieira@users.noreply.github.com>
Co-authored-by: Filipe G. Vieira <1151762+fgvieira@users.noreply.github.com>
@fgvieira
Copy link
Collaborator

It seems that ragtag outputs files to the same output folder. However, as stated in the PR QC, "file paths in the resulting rule can be changed arbitrarily".

One way to do it is to output everything to a temp folder, and then copy the relevant files to their final destinations (e.g. see STAR wrapper).

Co-authored-by: Filipe G. Vieira <1151762+fgvieira@users.noreply.github.com>
currocam and others added 9 commits May 31, 2023 09:58
Co-authored-by: Filipe G. Vieira <1151762+fgvieira@users.noreply.github.com>
Co-authored-by: Filipe G. Vieira <1151762+fgvieira@users.noreply.github.com>
Co-authored-by: Filipe G. Vieira <1151762+fgvieira@users.noreply.github.com>
Co-authored-by: Filipe G. Vieira <1151762+fgvieira@users.noreply.github.com>
Co-authored-by: Filipe G. Vieira <1151762+fgvieira@users.noreply.github.com>
Co-authored-by: Filipe G. Vieira <1151762+fgvieira@users.noreply.github.com>
@fgvieira
Copy link
Collaborator

fgvieira commented Jun 1, 2023

Thanks for your work on this!
I think it is fine now and have approved it but won't merge it now, just in case @johanneskoester has some more comments.

@currocam
Copy link
Contributor Author

currocam commented Jun 1, 2023

Thanks for your work on this! I think it is fine now and have approved it but won't merge it now, just in case @johanneskoester has some more comments.

Thx to you! I look forward to contributing more. I constantly use the wrappers when available :) Thanks for the thorough review :)

Copy link
Contributor

@johanneskoester johanneskoester left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I trust your judgement, @fgvieira! :-)

@johanneskoester johanneskoester merged commit 6a967c5 into snakemake:master Jun 7, 2023
6 checks passed
johanneskoester pushed a commit that referenced this pull request Jun 7, 2023
🤖 I have created a release \*beep\* \*boop\*
---
##
[1.32.0](https://www.github.com/snakemake/snakemake-wrappers/compare/v1.31.1...v1.32.0)
(2023-06-07)


### Features

* add ragtag wrapper
([#1397](https://www.github.com/snakemake/snakemake-wrappers/issues/1397))
([6a967c5](https://www.github.com/snakemake/snakemake-wrappers/commit/6a967c540801b30240c63ca12332bac8dbf0fe2c))
* add wrapper to plot nonpareil results
([#1398](https://www.github.com/snakemake/snakemake-wrappers/issues/1398))
([1b31bd5](https://www.github.com/snakemake/snakemake-wrappers/commit/1b31bd5fcf5b24d5b7603579c0d024aee64551ab))


### Bug Fixes

* bug with SE reads
([#1395](https://www.github.com/snakemake/snakemake-wrappers/issues/1395))
([f44c6a0](https://www.github.com/snakemake/snakemake-wrappers/commit/f44c6a0875794f13eb03983a876d00a5226ce02b))
* fastqc doesn't know how to process multiple files.
([#1327](https://www.github.com/snakemake/snakemake-wrappers/issues/1327))
([b5b9878](https://www.github.com/snakemake/snakemake-wrappers/commit/b5b9878a91bbbdc4ccb604d5b5864a12c34ba02d))
* indexed bam files can now be put as input
([#1378](https://www.github.com/snakemake/snakemake-wrappers/issues/1378))
([7c53b89](https://www.github.com/snakemake/snakemake-wrappers/commit/7c53b89cd6b70b4675f4ee82fd55982f4cfa51b1))


### Performance Improvements

* autobump bio/bcftools/filter
([#1383](https://www.github.com/snakemake/snakemake-wrappers/issues/1383))
([dab7630](https://www.github.com/snakemake/snakemake-wrappers/commit/dab7630075ae834c61918dc4ee5cb302022bc8ed))
* autobump bio/bcftools/view
([#1394](https://www.github.com/snakemake/snakemake-wrappers/issues/1394))
([8a8d877](https://www.github.com/snakemake/snakemake-wrappers/commit/8a8d877c51dce3c2a966f1ff884728d0333a49fd))
* autobump bio/bedtools/complement
([#1392](https://www.github.com/snakemake/snakemake-wrappers/issues/1392))
([7284ac2](https://www.github.com/snakemake/snakemake-wrappers/commit/7284ac2b1c38678db067c5c04fce590fdd9a85c9))
* autobump bio/bedtools/intersect
([#1403](https://www.github.com/snakemake/snakemake-wrappers/issues/1403))
([6a839c1](https://www.github.com/snakemake/snakemake-wrappers/commit/6a839c182d0d0c1f9dc54b5b560491ccf01b21ce))
* autobump bio/bustools/sort
([#1411](https://www.github.com/snakemake/snakemake-wrappers/issues/1411))
([54e2956](https://www.github.com/snakemake/snakemake-wrappers/commit/54e295607ac93101983916429de3bb3a9a1279fe))
* autobump bio/bwa-mem2/mem
([#1389](https://www.github.com/snakemake/snakemake-wrappers/issues/1389))
([9a5828c](https://www.github.com/snakemake/snakemake-wrappers/commit/9a5828cae18fe542e41b42796e9da03d50fbd8a6))
* autobump bio/bwa/samse
([#1405](https://www.github.com/snakemake/snakemake-wrappers/issues/1405))
([476f722](https://www.github.com/snakemake/snakemake-wrappers/commit/476f722e80a56405f93aa74480be74c558f83940))
* autobump bio/cutadapt/pe
([#1401](https://www.github.com/snakemake/snakemake-wrappers/issues/1401))
([38dfed4](https://www.github.com/snakemake/snakemake-wrappers/commit/38dfed4b9f5bd1504dd40bad2432b3ebf8096ce0))
* autobump bio/deeptools/bamcoverage
([#1409](https://www.github.com/snakemake/snakemake-wrappers/issues/1409))
([426852b](https://www.github.com/snakemake/snakemake-wrappers/commit/426852bfe9f60bd1c2d000f64af4c838d677f783))
* autobump bio/deeptools/computematrix
([#1373](https://www.github.com/snakemake/snakemake-wrappers/issues/1373))
([6f3e9b5](https://www.github.com/snakemake/snakemake-wrappers/commit/6f3e9b5eedd5019ea36e840e7cc7101dbdc77639))
* autobump bio/deseq2/deseqdataset
([#1369](https://www.github.com/snakemake/snakemake-wrappers/issues/1369))
([8ca67e8](https://www.github.com/snakemake/snakemake-wrappers/commit/8ca67e82ebb92e18dce5baf153f72b3e77bad7c6))
* autobump bio/fastq_screen
([#1375](https://www.github.com/snakemake/snakemake-wrappers/issues/1375))
([abb82c4](https://www.github.com/snakemake/snakemake-wrappers/commit/abb82c4a98be3c71e17de50670d19579f63901ec))
* autobump bio/gatk/learnreadorientationmodel
([#1407](https://www.github.com/snakemake/snakemake-wrappers/issues/1407))
([614f343](https://www.github.com/snakemake/snakemake-wrappers/commit/614f34377df8d7557959d15a50ff6238896bff64))
* autobump bio/gatk/scatterintervalsbyns
([#1387](https://www.github.com/snakemake/snakemake-wrappers/issues/1387))
([61944c3](https://www.github.com/snakemake/snakemake-wrappers/commit/61944c37e94c2ef80228f3310ef7e64fe3ab0f5e))
* autobump bio/gatk/selectvariants
([#1376](https://www.github.com/snakemake/snakemake-wrappers/issues/1376))
([e2962a1](https://www.github.com/snakemake/snakemake-wrappers/commit/e2962a14ccff2e339f5d137c729b1d5607b9e666))
* autobump bio/gatk/variantrecalibrator
([#1374](https://www.github.com/snakemake/snakemake-wrappers/issues/1374))
([341ccaa](https://www.github.com/snakemake/snakemake-wrappers/commit/341ccaac9e9343774c57477e8d6fede514b7c8eb))
* autobump bio/gatk3/indelrealigner
([#1371](https://www.github.com/snakemake/snakemake-wrappers/issues/1371))
([6ef06a1](https://www.github.com/snakemake/snakemake-wrappers/commit/6ef06a1e8fa5cad5a69906061d3827c656e6843b))
* autobump bio/hisat2/index
([#1370](https://www.github.com/snakemake/snakemake-wrappers/issues/1370))
([b5e37ab](https://www.github.com/snakemake/snakemake-wrappers/commit/b5e37ab3ed8bd70ed969a444274a183fa9ff36f8))
* autobump bio/last/lastdb
([#1400](https://www.github.com/snakemake/snakemake-wrappers/issues/1400))
([db60b46](https://www.github.com/snakemake/snakemake-wrappers/commit/db60b46ce39e9721770901a0b46084bc68823340))
* autobump bio/open-cravat/module
([#1399](https://www.github.com/snakemake/snakemake-wrappers/issues/1399))
([fc2b86a](https://www.github.com/snakemake/snakemake-wrappers/commit/fc2b86a92430d32b2d8f5f8aa1ee1a697959c1de))
* autobump bio/paladin/index
([#1379](https://www.github.com/snakemake/snakemake-wrappers/issues/1379))
([598d8e7](https://www.github.com/snakemake/snakemake-wrappers/commit/598d8e717261c02d663d99a0c81d44c8b9cfaac8))
* autobump bio/picard/bedtointervallist
([#1408](https://www.github.com/snakemake/snakemake-wrappers/issues/1408))
([b0f6786](https://www.github.com/snakemake/snakemake-wrappers/commit/b0f6786e60c03cd82eede73456853375a63877cf))
* autobump bio/picard/revertsam
([#1384](https://www.github.com/snakemake/snakemake-wrappers/issues/1384))
([007cbd1](https://www.github.com/snakemake/snakemake-wrappers/commit/007cbd17a36ada11943908d6c02dc4b8fc74a226))
* autobump bio/pyroe/makeunspliceunspliced
([#1406](https://www.github.com/snakemake/snakemake-wrappers/issues/1406))
([61d8377](https://www.github.com/snakemake/snakemake-wrappers/commit/61d83774a3c86e5624e61ea4594c325fddf8bdd3))
* autobump bio/samtools/sort
([#1410](https://www.github.com/snakemake/snakemake-wrappers/issues/1410))
([935a677](https://www.github.com/snakemake/snakemake-wrappers/commit/935a6770d422287330ed1977a44b4be245437026))
* autobump bio/snpsift/annotate
([#1390](https://www.github.com/snakemake/snakemake-wrappers/issues/1390))
([f59bb6b](https://www.github.com/snakemake/snakemake-wrappers/commit/f59bb6ba01e13333fc8693b9e55773814d37a0dc))
* autobump bio/spades/metaspades
([#1385](https://www.github.com/snakemake/snakemake-wrappers/issues/1385))
([df5c0d1](https://www.github.com/snakemake/snakemake-wrappers/commit/df5c0d18ce6a38a3db6206083414ee69fceeeecf))
* autobump bio/sra-tools/fasterq-dump
([#1380](https://www.github.com/snakemake/snakemake-wrappers/issues/1380))
([8b007a5](https://www.github.com/snakemake/snakemake-wrappers/commit/8b007a51a066cbba0f0a390a08fa8e5c60d8464c))
* autobump bio/strling/merge
([#1404](https://www.github.com/snakemake/snakemake-wrappers/issues/1404))
([f62427b](https://www.github.com/snakemake/snakemake-wrappers/commit/f62427b3abec766d7d13ad6d7f93c9c27456d363))
* autobump bio/ucsc/faToTwoBit
([#1388](https://www.github.com/snakemake/snakemake-wrappers/issues/1388))
([8356b4f](https://www.github.com/snakemake/snakemake-wrappers/commit/8356b4fe00cad3529484a821bc7582b6f5a88a51))
* autobump bio/ucsc/gtfToGenePred
([#1391](https://www.github.com/snakemake/snakemake-wrappers/issues/1391))
([32aa42f](https://www.github.com/snakemake/snakemake-wrappers/commit/32aa42f187351108aa7f6d2ca060c2446c16f9e6))
* autobump bio/ucsc/twoBitToFa
([#1393](https://www.github.com/snakemake/snakemake-wrappers/issues/1393))
([ae1453a](https://www.github.com/snakemake/snakemake-wrappers/commit/ae1453a323d11c7a4d5eee81031180f0db690e47))
* autobump bio/vep/annotate
([#1386](https://www.github.com/snakemake/snakemake-wrappers/issues/1386))
([3365493](https://www.github.com/snakemake/snakemake-wrappers/commit/3365493f7e2a93c55b700b9446ee5e73ab7c90cd))
* autobump bio/vg/construct
([#1381](https://www.github.com/snakemake/snakemake-wrappers/issues/1381))
([0785aac](https://www.github.com/snakemake/snakemake-wrappers/commit/0785aaca7e5ce77faadf3cfe49b23d6af551bf57))
* autobump bio/vg/ids
([#1354](https://www.github.com/snakemake/snakemake-wrappers/issues/1354))
([3743f2e](https://www.github.com/snakemake/snakemake-wrappers/commit/3743f2ec07af726542ed605f40377ad73c25b957))
* autobump bio/vg/prune
([#1377](https://www.github.com/snakemake/snakemake-wrappers/issues/1377))
([7dc7890](https://www.github.com/snakemake/snakemake-wrappers/commit/7dc7890769257d161731b2004401db4b6760bae6))
* autobump bio/vg/sim
([#1402](https://www.github.com/snakemake/snakemake-wrappers/issues/1402))
([3bf4bf7](https://www.github.com/snakemake/snakemake-wrappers/commit/3bf4bf754598d7efbff776d4a90cf3114c4e2383))
---


This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@currocam currocam deleted the ragtag-wrapper branch June 7, 2023 08:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants