Skip to content

sequana/sequana

Repository files navigation

SEQUANA

image

image

image

image

Documentation Status

JOSS (journal of open source software) DOI

Python 3.8 | 3.9 | 3.10 | 3.11

GitHub Issues

image

How to cite

Citations are important for us to carry on developments. For Sequana library (including the pipelines), please use

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

For the genome coverage tool (sequana_coverage): Desvillechabrol et al, 2018: detection and characterization of genomic variations using running median and mixture models. GigaScience, 7(12), 2018. https://doi.org/10.1093/gigascience/giy110

For Sequanix: Desvillechabrol et al. Sequanix: A Dynamic Graphical Interface for Snakemake Workflows Bioinformatics, bty034, https://doi.org/10.1093/bioinformatics/bty034 Also available on bioRxiv (DOI: https://doi.org/10.1101/162701)

Sequana includes a set of pipelines related to NGS (new generation sequencing) including quality control, variant calling, coverage, taxonomy, transcriptomics. We also ship Sequanix, a graphical user interface for Snakemake pipelines.

Pipelines and tools available in the Sequana project
name/github description Latest Pypi version Test passing apptainers
sequana_pipetools Create and Manage Sequana pipeline image image Not required
sequana-wrappers Set of wrappers to build pipelines Not on pypi image Not required
demultiplex Demultiplex your raw data image image License restriction
denovo denovo sequencing data image image image
fastqc Get Sequencing Quality control image image image
LORA Map sequences on target genome image image image
mapper Map sequences on target genome image image image
nanomerge Merge barcoded (or unbarcoded) nanopore fastq and reporting image image image
pacbio_qc Pacbio quality control image image image
ribofinder Find ribosomal content image image image
rnaseq RNA-seq analysis image image image
variant_calling Variant Calling image image image
multicov Coverage (mapping) image image image
laa Long read Amplicon Analysis image image image
revcomp reverse complement of sequence data image image image
downsampling downsample sequencing data image image Not required
depletion remove/select reads mapping a reference image image
Pipelines not yet released
name/github description Latest Pypi version Test passing
trf Find repeats image image
multitax Taxonomy analysis image image

Please see the documentation for an up-to-date status and documentation.

Contributors

Maintaining Sequana would not have been possible without users and contributors. Each contribution has been an encouragement to pursue this project. Thanks to all:

image

Changelog

Version Description

0.17.0

  • viz submodules: remove easydev and cleanup scipy imports
  • remove the substractor utility (use sequana_depletion pipeline instead)
  • remove get_max_gc_correlation function from bedtools. not used.
  • Major change in VCF reader (freebayes). Got rid of freebayes_bcf_filter redundant with freebayes_vcf_filter; replace scipy fisher test with own implementation. Remove useless VCF code.
  • Fixes rnadiff HTML report
  • speedup kegg enrichment using multiprocess
  • Allow sequana_taxonomy to download toydb and viruses_masking DBs from zenodo

0.16.9

  • Major fix on PCA and add batch effect plots in RNAdiff analysis
  • count matrix and DESeq2 output files' headers fixed with missing index (no impact on analysis but only for those willing to use the CSV files in excel)
  • Taxonomy revisited to save taxonomy.dat in gzipped CSV format.

0.16.8

  • update IEM for more testing
  • better handling of error in RNADiff
  • Add new methods for ribodesigner
0.16.7 * Stable release (fix doc), deprecated.
0.16.6 * Refactor IEM to make it more robust with more tests.

0.16.5

  • refactor to use pyproject instead of setuptools
  • remove pkg_resources (future deprecation)
  • remove unused requirements (cookiecutter, adjusttext, docutuils, mock, psutil, pykwalify)
  • cleanup resources (e.g. moving canvas/bar.py into viz)
0.16.4 * hot fixes on RNAdiff reports and enrichments

0.16.3

0.16.2

  • save coverage PNG image (regression)
  • Update taxonomy/coverage standalone (regression) and more tests
0.16.1 * hotfix missing module

0.16.0

  • add mpileup module
  • homogenization enrichment + fixup rnadiff
  • Complete refactoring of sequana coverage module. Allow sequana_coverage to handle small eukaryotes in a more memory efficient way.
  • use click for the sequana_taxonomy and sequana_coverage and sequana rnadiff command
  • Small fixup on homer, idr and phantom modules (for chipseq pipeline)
0.15.4 * add plot for rnaseq/rnadiff

0.15.3

  • add sequana.viz.plotly module. use tqdm in bamtools module
  • KEGG API changed. We update sequana to use headless server and keep the feature of annotated and colored pathway.
  • Various improvements on KEGG enrichment including saving pathways, addition --comparison option in sequana sub-command, plotly plots, etc

0.15.2

  • ribodesigner can now accept an input fasta with no GFF assuming the fasta already contains the rRNA sequences
  • Fix IEM module when dealing with double indexing
  • Fix anchors in HTML reports (rnadiff module)
  • refactorise compare module to take several rnadiff results as input
  • enrichment improvements (export KEGG and GO as csv files

0.15.1

  • Fix creation of images directory in modules report
  • add missing test related to gff
  • Fix #804

0.15.0

  • add logo in reports
  • RNADiff reports can now use shrinkage or not (optional)
  • remove useless rules now in sequana-wrappers
  • update main README to add LORA in list of pipelines
  • Log2FC values are now shrinked log2FC values in volcano plot and report table. "NotShrinked" columns for Log2FC and Log2FCSE prior shrinkage are displayed in report table.

0.14.6

  • add fasta_and_gff_annotation module to correct fasta and gff given a vcf file.
  • add macs3 module to read output of macs3 peak detector.
  • add idr module to read results of idr analysis
  • add phantom module to compute phantom peaks
  • add homer module to read annotation files from annotatePeaks

0.14.5

0.14.4

  • hotfix bug on kegg colorised pathways
  • Fix the hover_name in rnadiff volcano plot to include the index/attribute.
  • pin snakemake to be >=7.16

0.14.3

  • new fisher metric in variant calling
  • ability to use several feature in rnaseq/rnadiff
  • pin several libaries due to regression during installs
0.14.2 * Update ribodesigner

0.14.1

  • Kegg enrichment: add gene list 'all' and fix incomplete annotation case
  • New uniprot module for GO term enrichment and enrichment refactorisation (transparent for users)

0.14.0

  • pinned click>=8.1.0 due to API change (autocomplete)
  • moved tests around to decrease packaging from 16 to 4Mb
  • ribodesigner: new plots, clustering and notebook

0.13.X

  • Remove useless standalones or moved to main sequana command
  • Move sequana_lane_merging into a subcommand (sequana lane_merging)
  • General cleanup of documentation, test and links to pipelines
  • add new ribodesigner subcommand

0.12.X