joyling93/sc10x_wf

None

Overview

Topics:

Latest release: None, Last update: 2025-04-15

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/joyling93/sc10x_wf . --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.

目前流程仅支持转录组、空间转录组和gex+vdj测序，后续会逐步增加其他类型的数据流程。 物种仅支持homo_sapiens和mus_musculus，后续会逐步增加其他物种。

Linting and formatting

Linting results

 1The flag 'directory' used in rule rmd_report is only valid for outputs, not inputs.
 2Lints for rule get_cellranger (line 3, /tmp/tmpaow_hx7f/workflow/rules/resources.smk):
 3    * Specify a conda environment or container for each rule.:
 4      This way, the used software for each specific step is documented, and the
 5      workflow can be executed on any machine without prerequisites.
 6      Also see:
 7      https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#integrated-package-management
 8      https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#running-jobs-in-containers
 9
10Lints for rule get_reference (line 16, /tmp/tmpaow_hx7f/workflow/rules/resources.smk):
11    * Specify a conda environment or container for each rule.:
12      This way, the used software for each specific step is documented, and the
13      workflow can be executed on any machine without prerequisites.
14      Also see:
15      https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#integrated-package-management
16      https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#running-jobs-in-containers
17
18Lints for rule clean_names (line 30, /tmp/tmpaow_hx7f/workflow/rules/resources.smk):
19    * Specify a conda environment or container for each rule.:
20      This way, the used software for each specific step is documented, and the
21      workflow can be executed on any machine without prerequisites.
22      Also see:
23      https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#integrated-package-management
24      https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#running-jobs-in-containers
25
26Lints for rule get_template (line 43, /tmp/tmpaow_hx7f/workflow/rules/resources.smk):
27    * No log directive defined:
28      Without a log directive, all output will be printed to the terminal. In
29      distributed environments, this means that errors are harder to discover.
30      In local environments, output of concurrent jobs will be mixed and become
31      unreadable.
32      Also see:
33      https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#log-files
34    * Specify a conda environment or container for each rule.:
35      This way, the used software for each specific step is documented, and the
36      workflow can be executed on any machine without prerequisites.
37      Also see:
38      https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#integrated-package-management
39      https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#running-jobs-in-containers
40
41Lints for rule counts (line 31, /tmp/tmpaow_hx7f/workflow/rules/counts.smk):
42    * Specify a conda environment or container for each rule.:
43      This way, the used software for each specific step is documented, and the
44      workflow can be executed on any machine without prerequisites.
45      Also see:
46      https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#integrated-package-management
47      https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#running-jobs-in-containers
48
49Lints for rule rmd_report (line 1, /tmp/tmpaow_hx7f/workflow/rules/report.smk):
50    * No log directive defined:
51      Without a log directive, all output will be printed to the terminal. In
52      distributed environments, this means that errors are harder to discover.
53      In local environments, output of concurrent jobs will be mixed and become
54      unreadable.
55      Also see:
56      https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#log-files

Formatting results

 1[DEBUG] 
 2[DEBUG] In file "/tmp/tmpaow_hx7f/workflow/rules/counts.smk":  Formatted content is different from original
 3[DEBUG] 
 4[WARNING] In file "/tmp/tmpaow_hx7f/workflow/Snakefile":  Keyword "input" at line 49 has comments under a value.
 5	PEP8 recommends block comments appear before what they describe
 6(see https://www.python.org/dev/peps/pep-0008/#id30)
 7[DEBUG] In file "/tmp/tmpaow_hx7f/workflow/Snakefile":  Formatted content is different from original
 8[DEBUG] 
 9[DEBUG] In file "/tmp/tmpaow_hx7f/workflow/rules/cpdb.smk":  Formatted content is different from original
10[DEBUG] 
11[DEBUG] In file "/tmp/tmpaow_hx7f/workflow/rules/resources.smk":  Formatted content is different from original
12[DEBUG] 
13[DEBUG] In file "/tmp/tmpaow_hx7f/workflow/rules/common.smk":  Formatted content is different from original
14[DEBUG] 
15[DEBUG] In file "/tmp/tmpaow_hx7f/workflow/rules/monocle.smk":  Formatted content is different from original
16[DEBUG] 
17[DEBUG] In file "/tmp/tmpaow_hx7f/workflow/rules/report.smk":  Formatted content is different from original
18[DEBUG] 
19[DEBUG] In file "/tmp/tmpaow_hx7f/workflow/rules/singler.smk":  Formatted content is different from original
20[DEBUG] 
21[DEBUG] In file "/tmp/tmpaow_hx7f/workflow/rules/seurat.smk":  Formatted content is different from original
22[DEBUG] 
23[DEBUG] In file "/tmp/tmpaow_hx7f/workflow/rules/qc_reads.smk":  Formatted content is different from original
24[DEBUG] 
25[DEBUG] In file "/tmp/tmpaow_hx7f/workflow/rules/vdj.smk":  Formatted content is different from original
26[INFO] 11 file(s) would be changed 😬
27
28snakefmt version: 0.10.2