Skip to main content

NGS statter

A package to compute read/alignment statistics per fastq/bam files. This package is used as a part of an NGS analysis pipeline to generate intermediate QC results and final alignment statistics for all samples.

Parsers

  • Fastq parser
  • GFF parser
  • BAM parser
  • kraken2 report aggregator
  • fastp fastp trimming stats aggregator
  • STAR aligner alignment stats to json
  • parser fix UMI position in flexbar fastqs

Plotting functions

  • Fastq read length distribution plot
  • Overall aligned read length distribution plot
  • Gene type specific read length distribution plot
  • Alignment statistics

Installation

This package can be installed using pip:

$ pip install ngs-statter

Documentation

A detailed documentation is available at this read the docs page. A brief description of various commands available in this package is given below

Commands

use ngs-statter -h for a list of available helper commands.

Commands are grouped based on the input as follows:

alignment

Parse alignment (.bam) files and generate base statistics

command description usage
bam Compute basic alignment statistics for a generic BAM file ngs-statter bam -h
STAR Compute alignment statistics for a STAR aligned BAM file and output as JSON ngs-statter STAR -h

Parse output crosslink (.bed) files from Shoji or htseq-clip

command description usage
csv-meta-example Print example CSV metadata file for crosslink plotting to console ngs-statter csv-meta-example -h
count-crosslinks Count crosslinking sites over secondary structure/primary motif regions ngs-statter count-crosslinks -h
crosslink-line-plot Plot crosslinking sites over secondary structure/primary motif regions as line plots ngs-statter crosslink-line-plot -h
crosslink-heatmap Plot crosslinking sites over secondary structure/primary motif regions as heatmaps ngs-statter crosslink-heatmap -h

fastq

Parse fastq files to compute and plot read-length distributions

command description usage
parse-read-length Compute fastq read length distribution ngs-statter parse-read-length -h
plot-read-length Read in json formatted output files (from parse-read-length) and output html plot ngs-statter plot-read-length -h

flexbar

Fix the position of UMIs in flexbar output fastq files

command description usage
fix-header Fix flexbar UMI headers ngs-statter fix-header -h

genetype

Given a gff3 formatted gene annotation file and an alignment (.bam) file, compute and plot read-length distribution of reads aligning to gene types (protein coding, lncRNA,...).

command description usage
parse-gene-type-read-length Compute gene type read length distributions ngs-statter parse-gene-type-read-length -h
plot-gene-type-read-length Plot gene type read length distributions using outputs from parse-gene-type-read-length ngs-statter plot-gene-type-read-length -h

kraken

Given NCBI taxonomy files and a set of Kraken2 species classification reports, merge the reports into one single output.

command description usage
collect-reports Collect kraken2 reports into a single file ngs-statter collect-reports -h

sample

command description usage
sample-stats Collect statistics from various steps in a workflow (trimming, alignment,...) and compile into a single json file ngs-statter sample-stats -h
compile-stats Collect stats from multiple samples (output from sample-stats) into a single tsv file ngs-statter compile-stats -h

Hentze Group, EMBL Heidelberg

Metadata

Release files for NGS-statter 1.26.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for NGS-statter 1.26.0
File Interpreter ABI Platform Actions
ngs_statter-1.26.0-cp312-cp312-manylinux_2_28_x86_64.whl CPython 3.12 CPython 3.12 Linux glibc 2.28+ x86-64 Details for ngs_statter-1.26.0-cp312-cp312-manylinux_2_28_x86_64.whl

Release files / ngs_statter-1.26.0-cp312-cp312-manylinux_2_28_x86_64.whl

Download URL ngs_statter-1.26.0-cp312-cp312-manylinux_2_28_x86_64.whl
Size 3.7 MB
Tags CPython 3.12 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
c2a691d0544c34a3758e10d37a2771def63c955c32399403104257e6b311dc2e
BLAKE2b-256 checksum
How to use checksums
af1b5479cabc90aba0f13fe82419c92a4c7ecf605aa83d882d67e62ff2287415
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Security for NGS-statter 1.26.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.

Full provenance

1 file in this release has been uploaded with provenance metadata.

Attestation for ngs_statter-1.26.0-cp312-cp312-manylinux_2_28_x86_64.whl

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page