brunosate21-a11y/Metabolic-Modeling-Workflow.

None

Overview

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

Share link: https://snakemake.github.io/snakemake-workflow-catalog?wf=brunosate21-a11y/Metabolic-Modeling-Workflow.

Quality control: linting: failed formatting: failed

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/brunosate21-a11y/Metabolic-Modeling-Workflow. . --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:

  1. Download genome reference from NCBI

  2. Validate downloaded genome (python script)

  3. Simulate short read sequencing data on the fly (dwgsim)

  4. Check quality of input read data (FastQC)

  5. 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.yaml 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

Linting and formatting

Linting results
 1Lints for rule filter_checkm (line 18, /tmp/tmpyxa19380/workflow/rules/checkm.smk):
 2    * Specify a conda environment or container for each rule.:
 3      This way, the used software for each specific step is documented, and the
 4      workflow can be executed on any machine without prerequisites.
 5      Also see:
 6      https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#integrated-package-management
 7      https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#running-jobs-in-containers
 8
 9Lints for rule memote_summary (line 17, /tmp/tmpyxa19380/workflow/rules/memote.smk):
10    * Specify a conda environment or container for each rule.:
11      This way, the used software for each specific step is documented, and the
12      workflow can be executed on any machine without prerequisites.
13      Also see:
14      https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#integrated-package-management
15      https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#running-jobs-in-containers
16
17Lints for rule filter_memote (line 28, /tmp/tmpyxa19380/workflow/rules/memote.smk):
18    * Specify a conda environment or container for each rule.:
19      This way, the used software for each specific step is documented, and the
20      workflow can be executed on any machine without prerequisites.
21      Also see:
22      https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#integrated-package-management
23      https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#running-jobs-in-containers
Formatting results
 1[DEBUG] 
 2[DEBUG] In file "/tmp/tmpyxa19380/workflow/rules/steadycom.smk":  Formatted content is different from original
 3[DEBUG] 
 4[DEBUG] In file "/tmp/tmpyxa19380/workflow/rules/smetana.smk":  Formatted content is different from original
 5[DEBUG] 
 6[DEBUG] In file "/tmp/tmpyxa19380/workflow/rules/checkm.smk":  Formatted content is different from original
 7[DEBUG] 
 8[DEBUG] In file "/tmp/tmpyxa19380/workflow/rules/micom.smk":  Formatted content is different from original
 9[DEBUG] 
10[DEBUG] In file "/tmp/tmpyxa19380/workflow/rules/carveme.smk":  Formatted content is different from original
11[DEBUG] 
12[DEBUG] In file "/tmp/tmpyxa19380/workflow/rules/memote.smk":  Formatted content is different from original
13[DEBUG] 
14[WARNING] In file "/tmp/tmpyxa19380/workflow/Snakefile":  Keyword "input" at line 29 has comments under a value.
15	PEP8 recommends block comments appear before what they describe
16(see https://www.python.org/dev/peps/pep-0008/#id30)
17[DEBUG] In file "/tmp/tmpyxa19380/workflow/Snakefile":  Formatted content is different from original
18[INFO] 7 file(s) would be changed 😬
19
20snakefmt version: 0.11.5