Skip to main content

reverse complement a set of FastQ files

Project description

https://badge.fury.io/py/sequana-revcomp.svg JOSS (journal of open source software) DOI https://github.com/sequana/revcomp/actions/workflows/main.yml/badge.svg Python 3.11 | 3.12

This is is the revcomp pipeline from the Sequana projet

Overview:

revert and complement input Fast files

Input:

A set of FastQ files (paired or single-end) compressed or not

Output:

A set of reverse completed files

Status:

production

Citation:

Cokelaer et al, (2017), ‘Sequana’: a Set of Snakemake NGS pipelines, Journal of Open Source Software, 2(16), 352, JOSS DOI https://doi:10.21105/joss.00352

Installation

If you already have all requirements, you can install the packages using pip:

pip install sequana_revcomp --upgrade

Usage

This command will scan all files ending in .fastq.gz found in the local directory, create a directory called revcomp where a snakemake pipeline can be executed.:

::

sequana_revcomp –input-directory DATAPATH

This creates a directory with the pipeline and configuration file. You will then need to execute the pipeline:

cd revcomp
bash revcomp.sh  # for a local run

This launches a snakemake pipeline.

Requirements

This pipelines requires the following executable(s):

  • seqtk

Details

This pipeline runs seqtk in parallel on the input fastq files.

Rules and configuration details

Here is the latest documented configuration file to be used with the pipeline. Each rule used in the pipeline may have a section in the configuration file.

Changelog

Version

Description

1.2.0

  • migrated to modern sequana layout (poetry, rich_click, no click_completion, seqtk shell call – no sequana_wrappers)

1.1.0

  • set apptainer container

0.9.0

  • set singularity container

0.8.4

  • implemented –from-project option

0.8.3

  • Uses new sequana framework to spee up –help calls

  • –threads option

0.8.2

Fix schema and rule. output files are now saved in the ./rc directory

0.8.1

Improve the –help message

0.8.0

First version from sequana 0.8.0

Contribute & Code of Conduct

To contribute to this project, please take a look at the Contributing Guidelines first. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sequana_revcomp-1.2.0.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sequana_revcomp-1.2.0-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file sequana_revcomp-1.2.0.tar.gz.

File metadata

  • Download URL: sequana_revcomp-1.2.0.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sequana_revcomp-1.2.0.tar.gz
Algorithm Hash digest
SHA256 0d0a7deeb81845a04e70cf9131b0b1bdcd33905bbf4adbcaf3f3235067576571
MD5 dad63793e9760c096b0536fd8c3be050
BLAKE2b-256 ce9cb50a8feea73a1ba24d19a22f7491d045d855e1adb5b9904a92805f871a13

See more details on using hashes here.

File details

Details for the file sequana_revcomp-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sequana_revcomp-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cb63d54ccd6f7c0c593e95e887c51b67453e68c0ec7902ea952fa29ebf71f3e9
MD5 8a1f48256f4d79647f2303a2b5376c39
BLAKE2b-256 cfa54a66736dfba3658683733ab385768f6b6f863779a8bfbf35923e97c34f06

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page