Pipelines#
Sequana ships a family of NGS pipelines, each in its own GitHub repository and PyPI package. They share a common installation pattern, CLI shape, and HTML report layout.
Quick start#
pip install sequana_<name> --upgrade
sequana_<name> --help
For example:
pip install sequana_fastqc --upgrade
sequana_fastqc --input-directory my_data
cd fastqc && sh fastqc.sh
The configuration file config.yaml lives next to the snakefile in the
working directory and can be edited before launch. See
Pipeline user guide for a walkthrough of the common options.
Containers#
Every Sequana pipeline ships an apptainers.yaml pointing at the
matching damona image. Pull them on demand
with:
sequana_<name> ... --use-apptainer
This is the recommended way to avoid conda / system tool clashes.
Pipeline catalogue#
Quality control#
Pipeline |
Description |
Repository |
|---|---|---|
|
Sequencing quality control (FastQC + MultiQC). |
|
|
PacBio long-read quality control. |
|
|
Estimate ribosomal content of a sample. |
Mapping and coverage#
Pipeline |
Description |
Repository |
|---|---|---|
|
Map reads onto a target genome (bowtie2 / bwa / minimap2). |
|
|
Multi-sample coverage analysis. |
Variants and RNA-seq#
Pipeline |
Description |
Repository |
|---|---|---|
|
Variant calling (freebayes + snpEff + coverage). |
|
|
Full RNA-seq pipeline (alignment, counts, DESeq2 report). |
Long-read pipelines#
Pipeline |
Description |
Repository |
|---|---|---|
|
Map long reads onto a target genome. |
|
|
Merge barcoded (or unbarcoded) Nanopore FASTQ files + report. |
|
|
Long-read amplicon analysis. |
Taxonomy and assembly#
Pipeline |
Description |
Repository |
|---|---|---|
|
Taxonomic profiling of multiple samples. |
|
|
De-novo assembly (digital normalisation + assembler + QC). |
Utilities#
Pipeline |
Description |
Repository |
|---|---|---|
|
Demultiplex raw Illumina runs (bcl2fastq / bcl-convert). |
|
|
Downsample FASTQ/BAM files. |
|
|
Remove or select reads mapping a reference. |
|
|
Reverse-complement sequence data. |
|
|
Tandem repeats finder wrapper. |
For the complete and always-up-to-date list see the sequana GitHub organisation.
Pipeline reference pages#
A handful of pipelines have a dedicated page in this manual. They embed the
README of the corresponding repository via the sequana_pipeline Sphinx
directive.
Naming convention#
Each pipeline is distributed as sequana_<name> (PyPI) and installs a
console script named sequana_<name>. For historical pipelines also exposed
as standalone tools (sequana_coverage), the pipeline form is
sequana_pipelines_<name> to disambiguate.