To use this pipeline use the Fork option, on the top right of the repo.
This pipeline uses the Snakemake workflow manager for PE RNA sequencing data processing.
This is the current workflow for the snakemake rules.
-
Fork the pipeline to create your own project repo.
-
Create the
config/sample_manifest.tsvusing the following structure:-
Identifier: Facility ID
-
Condition: Condition (treated/untreated, fed/starved, etc.)
-
Bio_rep: Biological replicate number
-
Target_genome: ENCODE target genome for sequencing (supported options: M25, M32, 19, 38)
-
Sequencer: Sequencer to define —2colour parameter for the trimming (supported options: HiSeq4000, NovaSeq, NextSeq500)
-
Fastq_handle: Particular handle useful for raw
.fastq.gzfiles selection using the name from the facility (number, extension, etc.)Sample manifest example available here.
-
-
Copy raw sequencing data. For this there are 2
inputoptions (data with 2 sequencing lanes, unique lane/merged files).-
For
fastq.gzfiles from 2 sequencing lanes. Copy all yourfastq.gztoresources/fastq_seq/raw, with no additional subfolder and keeping the original facility names (see bellow for the usual facility filenames). Your folder should look like this:resources/fastq_seq/raw ├── {Identifier}_S{Fastq_handle}_L001_R1_001.fastq.gz ├── {Identifier}_S{Fastq_handle}_L002_R1_001.fastq.gz ├── {Identifier}_S{Fastq_handle}_L001_R2_001.fastq.gz └── {Identifier}_S{Fastq_handle}_L002_R2_001.fastq.gz
As a result you should have 4
fastq.gzfiles per sample (2 reads with 2 lanes each).Note that the
{wildcards}correspond to the columns on theconfig/sample_manifest.tsv.-
For
fastq.gzfiles from merged lanes or unique. Manually copy yourfastq.gztoresources/fastq_seq/merged, with a subfolder for each sample, named using the following structure:resources/fastq_seq/merged ├── {condition}_Bio-rep_{Bio_rep} │ ├── {condition}_Bio-rep_{Bio_rep}_R1.fq.gz │ └── {condition}_Bio-rep_{Bio_rep}_R2.fq.gz │ └── {condition}_Bio-rep_{Bio_rep} ├── {condition}_Bio-rep_{Bio_rep}_R1.fq.gz └── {condition}_Bio-rep_{Bio_rep}_R2.fq.gz
As a result you should have 2
fq.gzfiles per sample (2 reads each).Note that the
{wildcards}correspond to the columns on theconfig/sample_manifest.tsv. And the extension isfq.gzinstead offastq.gz. -
-
Change processing parameters on your
config/config.yaml. -
Run the pipeline.
Your pipeline should look like this:
<YOUR PROJECT FOLDER> ├── config │ ├── config.yaml │ └── sample_manifest.tsv ├── profiles | └── profile ├── resources | └── fastq_seq | └── raw or merged └── workflowUse the following command on your project folder:
snakemake --profile profiles/<YOUR_PROFILE> --use-conda -j<N_JOBS>
For more options checkout the --help
-
This pipeline only works with paired-end Illumnia sequencing reads
-
The original pipeline has a
merge_fq_lanesrule adapted for particularinput fastq.gz filenames, for more information check step 3 on Getting started. -
The default configurations for this workflow are suitable to run snakemake on the
Helmholtz-Munich HPCand using conda to deal with software dependencies. If one wishes to run the pipeline on a different computing platform, the profiles need to be adapted accordingly. -
The pipeline only supports GENCODE genomes as reference, choose the right
GENCODE Realeaseas value for theTarget_genomeentry in yourconfig/sample_manifest.tsv. These are the equivalent realeases for GENCODE and UCSC databases:Organism GENCODE Realease GENCODE Genome UCSC Genome Mouse M25 GRCm38 mm10 Mouse M32 (Latest) GRCm38 mm39 Human 19 GRCh37 h19 Human 38 GRCh38 h38
Paulina Rosales-Becerra, Kevin Brokers, Saulius Lukauskas & Robert Schneider
paulina.rosales@helmholtz-muenchen.de
Actual version works just fine :)