Skip to main content

This is is the fastqc pipeline from the Sequana projet

Overview:

Runs fastqc and multiqc on a set of Sequencing data to produce control quality reports

Input:

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

Output:

an HTML file summary.html (individual fastqc report)

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

You must install Sequana first:

pip install sequana

Then, just install this package:

pip install sequana_fastqc

Usage

sequana_pipelines_fastqc --help
sequana_pipelines_fastqc --input-directory DATAPATH

This creates a directory fastq. You just need to execute the pipeline:

cd fastqc
sh fastqc.sh  # for a local run

This launch a snakemake pipeline. If you are familiar with snakemake, you can retrieve the fastqc.rules and config.yaml files and then execute the pipeline yourself with specific parameters:

snakemake -s fastqc.rules --cores 4 --stats stats.txt

Or use sequanix interface.

Tutorial

You can retrieve test data from sequana_fastqc (https://github.com/sequana/sequana_fastqc) or type:

wget https://raw.githubusercontent.com/sequana/sequana_fastqc/master/sequana_pipelines/fastqc/data/data_R1_001.fastq.gz
wget https://raw.githubusercontent.com/sequana/sequana_fastqc/master/sequana_pipelines/fastqc/data/data_R2_001.fastq.gz

then, prepare the pipeline:

sequana_fastqc --input-directory .
cd fastqc
sh fastq.sh

# once done, remove temporary files (snakemake and others)
make clean

Just open the HTML entry called summary.html. A multiqc report is also available. You will get expected images such as the following one:

https://github.com/sequana/sequana_fastqc/blob/master/doc/summary.png?raw=true

Requirements

This pipelines requires the following executable(s):

  • fastqc

https://raw.githubusercontent.com/sequana/sequana_fastqc/master/sequana_pipelines/fastqc/dag.png

Details

This pipeline runs fastqc in parallel on the input fastq files (paired or not) and then execute multiqc. 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.9.14

  • round up some statistics in the main table

0.9.13

  • improve the summary HTML report

0.9.12

  • implemented new –from-project option

0.9.11

  • now depends on sequana_pipetools instead of sequana.pipelines to speed up –help calls

  • new summary.html report created with pipeline summary

  • new rule (plotting)

0.9.10

  • simplify the onsuccess section

0.9.9

  • add missing png and pipeline (regression bug)

0.9.8

  • add missing multi_config file

0.9.7

  • check existence of input directory in main.py

  • add a logo

  • fix schema

  • add multiqc_config

  • add sequana + sequana_fastqc version

0.9.6

add the readtag option

Download files

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

Source Distribution

sequana_fastqc-0.9.14.tar.gz (125.9 kB view details)

Uploaded Source

File details

Details for the file sequana_fastqc-0.9.14.tar.gz.

File metadata

  • Download URL: sequana_fastqc-0.9.14.tar.gz
  • Upload date:
  • Size: 125.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200325 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.3

File hashes

Hashes for sequana_fastqc-0.9.14.tar.gz
Algorithm Hash digest
SHA256 5af0e790f842ab3b5527555c80f501341d54870186b25ee78829d9b669438baf
MD5 69137cef69d415eb32122c70314b0b77
BLAKE2b-256 f4245fae4343fb503ae6c33e7b4544d1e022150402f72126f3c1feb44edab9fa

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 Sentry Error logging StatusPage Status page