This is is the depletion pipeline from the Sequana project
- Overview:
select or deplete reads from input FastQ files given a reference
- Input:
Fastq Files
- Output:
Fastq 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 doi:10.21105/joss.00352
Installation
Install this package as follows:
pip install sequana_depletion
it requires https://sequana.readthedocs.io and https://bioconvert.readthedocs.io for the bam to fastq conversion
Usage
sequana_depletion --help sequana_depletion --input-directory DATAPATH --reference hg38.fa --mode depletion sequana_depletion --input-directory DATAPATH --reference covid.fa --mode selection
This creates a directory with the pipeline and configuration file. You will then need to execute the pipeline:
cd depletion sh depletion.sh # for a local run
This launch a snakemake pipeline. If you are familiar with snakemake, you can retrieve the pipeline itself and its configuration files and then execute the pipeline yourself with specific parameters:
snakemake -s depletion.rules -c config.yaml --cores 4 --stats stats.txt
Or use sequanix interface.
Requirements
This pipelines requires the following executable(s):
bwa
samtools
pigz
Details
This pipeline runs depletion in parallel on the input fastq files (paired or not). A brief sequana summary report is also produced.
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 |
|---|---|
0.4.0 |
|
0.3.0 |
|
0.2.0 |
|
0.1.0 |
First release. |
1 maintainer
Metadata
1 maintainer
Release files for sequana-depletion 0.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sequana_depletion-0.4.0.tar.gz | 8.0 kB | Without provenance | Details for sequana_depletion-0.4.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sequana_depletion-0.4.0-py3-none-any.whl | Python 3 | none | any | Details for sequana_depletion-0.4.0-py3-none-any.whl |
Total release size: 18.7 kB
Release files / sequana_depletion-0.4.0.tar.gz
| Download URL | sequana_depletion-0.4.0.tar.gz |
|---|---|
| Size | 8.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0dd505edf07206770343503f501603b69b5fa91ce2107fa2ecd217f071edf9eb
|
|
BLAKE2b-256 checksum How to use checksums |
62704db1c6de79681179034e9323b134d839cb83282acc126b9fc0b4b01cc6e4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.0.1 CPython/3.10.14 Linux/6.14.5-100.fc40.x86_64
|
Release files / sequana_depletion-0.4.0-py3-none-any.whl
| Download URL | sequana_depletion-0.4.0-py3-none-any.whl |
|---|---|
| Size | 10.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
afa22171b682f4cf687376e85e2880dd4fce161277fa70e7145bae77e8f6eb06
|
|
BLAKE2b-256 checksum How to use checksums |
dc3a0dd0b76db668ba94a5cadbc5c8b642cd19a523760b7be034c6c32a09f9c4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.0.1 CPython/3.10.14 Linux/6.14.5-100.fc40.x86_64
|
Security for sequana-depletion 0.4.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
