kevinrue/snakemake-cncb-2024

None

Overview

Latest release: None, Last update: 2024-11-20

Linting: linting: failed, Formatting: formatting: failed

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/kevinrue/snakemake-cncb-2024 . --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 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.

Describe how to configure the workflow (using config.yaml and maybe additional files). All of them need to be present with example entries inside of the config folder.

Linting and formatting

Linting results

 1Lints for snakefile /tmp/tmpst844b80/workflow/alevin.smk:
 2    * Mixed rules and functions in same snakefile.:
 3      Small one-liner functions used only once should be defined as lambda
 4      expressions. Other functions should be collected in a common module, e.g.
 5      'rules/common.smk'. This makes the workflow steps more readable.
 6      Also see:
 7      https://snakemake.readthedocs.io/en/latest/snakefiles/modularization.html#includes
 8
 9Lints for snakefile /tmp/tmpst844b80/workflow/genome.smk:
10    * Mixed rules and functions in same snakefile.:
11      Small one-liner functions used only once should be defined as lambda
12      expressions. Other functions should be collected in a common module, e.g.
13      'rules/common.smk'. This makes the workflow steps more readable.
14      Also see:
15      https://snakemake.readthedocs.io/en/latest/snakefiles/modularization.html#includes
16
17Lints for rule download_gtf (line 17, /tmp/tmpst844b80/workflow/alevin.smk):
18    * Shell command directly uses variable download_gtf_cmd_str from outside of the rule:
19      It is recommended to pass all files as input and output, and non-file
20      parameters via the params directive. Otherwise, provenance tracking is
21      less accurate.
22      Also see:
23      https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#non-file-parameters-for-rules
24
25Lints for rule genome_prepare_reference_fasta (line 29, /tmp/tmpst844b80/workflow/genome.smk):
26    * Shell command directly uses variable prepare_reference_genome_fasta_cmd_str from outside of the rule:
27      It is recommended to pass all files as input and output, and non-file
28      parameters via the params directive. Otherwise, provenance tracking is
29      less accurate.
30      Also see:
31      https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#non-file-parameters-for-rules
32
33Lints for rule genome_merge_gcvfs (line 193, /tmp/tmpst844b80/workflow/genome.smk):
34    * Shell command directly uses variable merge_gcvfs_inputs_str from outside of the rule:
35      It is recommended to pass all files as input and output, and non-file
36      parameters via the params directive. Otherwise, provenance tracking is
37      less accurate.
38      Also see:
39      https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#non-file-parameters-for-rules

Formatting results

1[DEBUG] 
2[DEBUG] In file "/tmp/tmpst844b80/workflow/Snakefile":  Formatted content is different from original
3[INFO] 1 file(s) would be changed 😬
4
5snakefmt version: 0.10.2