sims-lab/snakemake-cncb-genetic-demultiplexing
None
Overview
Latest release: None, Last update: 2025-07-23
Linting: linting: failed, Formatting: formatting: failed
Wrappers: bio/bcftools/index bio/bcftools/merge bio/bcftools/view bio/bwa/mem bio/gatk/haplotypecaller bio/multiqc bio/picard/markduplicates bio/samtools/flagstat bio/samtools/idxstats bio/samtools/index bio/samtools/sort
Deployment
Step 1: Install Snakemake and Snakedeploy
Snakemake and Snakedeploy are best installed via the Mamba package manager (a drop-in replacement for conda). If you have neither Conda nor Mamba, it is recommended to install Miniforge. More details regarding Mamba can be found here.
When using Mamba, run
mamba create -c conda-forge -c bioconda --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
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/sims-lab/snakemake-cncb-genetic-demultiplexing . --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 <detailed description>
.
The workflow is built using snakemake and consists of the following steps:
Download genome reference from NCBI
Validate downloaded genome (
python
script)Simulate short read sequencing data on the fly (
dwgsim
)Check quality of input read data (
FastQC
)Collect statistics from tool output (
MultiQC
)
Running the workflow
Input data
This template workflow creates artificial sequencing data in *.fastq.gz
format.
It does not contain actual input data.
The simulated input files are nevertheless created based on a mandatory table linked in the config.yml
file (default: .test/samples.tsv
).
The sample sheet has the following layout:
sample |
condition |
replicate |
read1 |
read2 |
---|---|---|---|---|
sample1 |
wild_type |
1 |
sample1.bwa.read1.fastq.gz |
sample1.bwa.read2.fastq.gz |
sample2 |
wild_type |
2 |
sample2.bwa.read1.fastq.gz |
sample2.bwa.read2.fastq.gz |
Parameters
This table lists all parameters that can be used to run the workflow.
parameter |
type |
details |
default |
---|---|---|---|
samplesheet |
|||
path |
str |
path to samplesheet, mandatory |
“config/samples.tsv” |
get_genome |
|||
ncbi_ftp |
str |
link to a genome on NCBI’s FTP server |
link to S. cerevisiae genome |
simulate_reads |
|||
read_length |
num |
length of target reads in bp |
100 |
read_number |
num |
number of total reads to be simulated |
10000 |
Linting and formatting
Linting results
1No validator found for JSON Schema version identifier 'http://json-schema.org/draft-07/schema#'
2Defaulting to validator for JSON Schema version 'https://json-schema.org/draft/2020-12/schema'
3Note that schema file may not be validated correctly.
4No validator found for JSON Schema version identifier 'http://json-schema.org/draft-07/schema#'
5Defaulting to validator for JSON Schema version 'https://json-schema.org/draft/2020-12/schema'
6Note that schema file may not be validated correctly.
7Lints for snakefile /tmp/tmp8vp7fj6i/workflow/rules/process_reads.smk:
8 * Mixed rules and functions in same snakefile.:
9 Small one-liner functions used only once should be defined as lambda
10 expressions. Other functions should be collected in a common module, e.g.
11 'rules/common.smk'. This makes the workflow steps more readable.
12 Also see:
13 https://snakemake.readthedocs.io/en/latest/snakefiles/modularization.html#includes
14
15Lints for rule concatenate_fastqs (line 18, /tmp/tmp8vp7fj6i/workflow/rules/process_reads.smk):
16 * Specify a conda environment or container for each rule.:
17 This way, the used software for each specific step is documented, and the
18 workflow can be executed on any machine without prerequisites.
19 Also see:
20 https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#integrated-package-management
21 https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#running-jobs-in-containers
22
23Lints for rule mrna_bed (line 173, /tmp/tmp8vp7fj6i/workflow/rules/process_reads.smk):
24 * Specify a conda environment or container for each rule.:
25 This way, the used software for each specific step is documented, and the
26 workflow can be executed on any machine without prerequisites.
27 Also see:
28 https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#integrated-package-management
29 https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#running-jobs-in-containers
30
31Lints for rule cellranger_count (line 244, /tmp/tmp8vp7fj6i/workflow/rules/process_reads.smk):
32 * No log directive defined:
33 Without a log directive, all output will be printed to the terminal. In
34 distributed environments, this means that errors are harder to discover.
35 In local environments, output of concurrent jobs will be mixed and become
36 unreadable.
37 Also see:
38 https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#log-files
39 * Specify a conda environment or container for each rule.:
40 This way, the used software for each specific step is documented, and the
41 workflow can be executed on any machine without prerequisites.
42 Also see:
43 https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#integrated-package-management
44 https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#running-jobs-in-containers
45
46Lints for rule cellranger_filtered_stats (line 1, /tmp/tmp8vp7fj6i/workflow/rules/qc.smk):
47 * No log directive defined:
48 Without a log directive, all output will be printed to the terminal. In
49 distributed environments, this means that errors are harder to discover.
50 In local environments, output of concurrent jobs will be mixed and become
51 unreadable.
52 Also see:
53 https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#log-files
54
55Lints for rule cellranger_web_summary (line 1, /tmp/tmp8vp7fj6i/workflow/rules/reports.smk):
56 * No log directive defined:
57 Without a log directive, all output will be printed to the terminal. In
58 distributed environments, this means that errors are harder to discover.
59 In local environments, output of concurrent jobs will be mixed and become
60 unreadable.
61 Also see:
62 https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#log-files
63 * Specify a conda environment or container for each rule.:
64 This way, the used software for each specific step is documented, and the
65 workflow can be executed on any machine without prerequisites.
66 Also see:
67 https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#integrated-package-management
68 https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#running-jobs-in-containers
69
70Lints for rule report_vireo_all (line 9, /tmp/tmp8vp7fj6i/workflow/rules/reports.smk):
71 * No log directive defined:
72 Without a log directive, all output will be printed to the terminal. In
73 distributed environments, this means that errors are harder to discover.
74 In local environments, output of concurrent jobs will be mixed and become
75 unreadable.
76 Also see:
77 https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#log-files
78
79Lints for rule report_droplet_filtering_metrics (line 23, /tmp/tmp8vp7fj6i/workflow/rules/reports.smk):
80 * No log directive defined:
81 Without a log directive, all output will be printed to the terminal. In
82 distributed environments, this means that errors are harder to discover.
83 In local environments, output of concurrent jobs will be mixed and become
84 unreadable.
85 Also see:
86 https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#log-files
87
88Lints for rule report_index (line 41, /tmp/tmp8vp7fj6i/workflow/rules/reports.smk):
89 * No log directive defined:
90 Without a log directive, all output will be printed to the terminal. In
91 distributed environments, this means that errors are harder to discover.
92 In local environments, output of concurrent jobs will be mixed and become
93 unreadable.
94 Also see:
95 https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#log-files
Formatting results
1[DEBUG]
2[DEBUG] In file "/tmp/tmp8vp7fj6i/workflow/rules/reports.smk": Formatted content is different from original
3[DEBUG]
4[DEBUG]
5[DEBUG]
6[WARNING] In file "/tmp/tmp8vp7fj6i/workflow/rules/process_reads.smk": Keyword "shell" at line 322 has comments under a value.
7 PEP8 recommends block comments appear before what they describe
8(see https://www.python.org/dev/peps/pep-0008/#id30)
9[DEBUG] In file "/tmp/tmp8vp7fj6i/workflow/rules/process_reads.smk": Formatted content is different from original
10[DEBUG]
11[INFO] 2 file(s) would be changed 😬
12[INFO] 3 file(s) would be left unchanged 🎉
13
14snakefmt version: 0.11.0