mpitz123/RNA_seq_alignment

Preparation and alignment of RNA_seq paired-end data with Hisat2 and Picard and counting with HTseq

Overview

Latest release: None, Last update: 2026-11-05

Share link: https://snakemake.github.io/snakemake-workflow-catalog?wf=mpitz123/RNA_seq_alignment

Quality control: linting: failed formatting: passed

Deployment

Step 1: Install Snakemake and Snakedeploy

Snakemake and Snakedeploy are best installed via the Conda package manager. It is recommended to install conda via Miniforge. Run

conda create -c conda-forge -c bioconda -c nodefaults --name snakemake snakemake snakedeploy

to install both Snakemake and Snakedeploy in an isolated environment. For all following commands ensure that this environment is activated via

conda activate snakemake

For other installation methods, refer to the Snakemake and Snakedeploy documentation.

Step 2: Deploy workflow

With Snakemake and Snakedeploy installed, the workflow can be deployed as follows. First, create an appropriate project working directory on your system and enter it:

mkdir -p path/to/project-workdir
cd path/to/project-workdir

In all following steps, we will assume that you are inside of that directory. Then run

snakedeploy deploy-workflow https://github.com/mpitz123/RNA_seq_alignment . --tag None

Snakedeploy will create two folders, workflow and config. The former contains the deployment of the chosen workflow as a Snakemake module, the latter contains configuration files which will be modified in the next step in order to configure the workflow to your needs.

Step 3: Configure workflow

To configure the workflow, adapt config/config.yml to your needs following the instructions below.

Step 4: Run workflow

The deployment method is controlled using the --software-deployment-method (short --sdm) argument.

To run the workflow using apptainer/singularity, use

snakemake --cores all --sdm apptainer

To run the workflow using a combination of conda and apptainer/singularity for software deployment, use

snakemake --cores all --sdm conda apptainer

To run the workflow with automatic deployment of all required software via conda/mamba, use

snakemake --cores all --sdm conda

Snakemake will automatically detect the main Snakefile in the workflow subfolder and execute the workflow module that has been defined by the deployment in step 2.

For further options such as cluster and cloud execution, see the docs.

Step 5: Generate report

After finalizing your data analysis, you can automatically generate an interactive visual HTML report for inspection of results together with parameters and code inside of the browser using

snakemake --report report.zip

Configuration

The following section is imported from the workflow’s config/README.md.

Workflow overview

This workflow is a best-practice workflow for RNA seq alignment with Hisat2. The workflow is built using snakemake and consists of the following steps:

  1. load predefined data and name gathering rule (workflow/rules/common.smk)

  2. Preparing the Hisat2 index, using splice-sites and exons

  3. Trimming the reads

  4. Aligning, sorting and deduplicating reads

  5. Check quality of input read data (FastQC)

  6. Collect statistics from outputs (MultiQC)

Running the workflow

Input data

This workflow uses data in the fq.gz format The input files are located in example_data/samples. The sample sheet has the following layout:

sample

r1

r2

sample1

sample1_1.fq.gz

sample1_2.fq.gz

sample2

sample2_1.fq.gz

sample2_2.fq.gz

Parameters

This table lists all parameters that can be used to run the workflow.

parameter

type

details

default

sample_sheet

path

str

path to sample sheet, mandatory

“config/samples.tsv”

reference

path

str

path to reference .fa and gff3, mandatory

” fa: “example_data/Genome/Zm-B73-REFERENCE-NAM-5.0.fa”

gff: “example_data/Genome/Zm-B73-REFERENCE-NAM-5.0_Zm00001eb.1.gff3””

Linting and formatting

Linting results
 1/home/runner/work/snakemake-workflow-catalog/snakemake-workflow-catalog/.pixi/envs/default/lib/python3.13/site-packages/google/auth/transport/grpc.py:43: FutureWarning: grpcio < 1.83.0 does not support Post-Quantum Cryptography (PQC). Support for non-PQC environments is deprecated. In April 2027, google-auth will raise its minimum requirements to enforce grpcio >= 1.83.0. For more details on Google Cloud's post-quantum security migration, visit: https://cloud.google.com/security/resources/post-quantum-cryptography
 2  warnings.warn(
 3Lints for snakefile /tmp/tmpgnwimn6u/workflow/Snakefile:
 4    * Path composition with '+' in line 9:
 5      This becomes quickly unreadable. Usually, it is better to endure some
 6      redundancy against having a more readable workflow. Hence, just repeat
 7      common prefixes. If path composition is unavoidable, use pathlib or
 8      (python >= 3.6) string formatting with f"...".
 9
10Lints for snakefile /tmp/tmpgnwimn6u/workflow/rules/common.smk:
11    * Path composition with '+' in line 7:
12      This becomes quickly unreadable. Usually, it is better to endure some
13      redundancy against having a more readable workflow. Hence, just repeat
14      common prefixes. If path composition is unavoidable, use pathlib or
15      (python >= 3.6) string formatting with f"...".
Formatting results
All tests passed!