clarajegousse/hanoxy

None

Overview

Latest release: None, Last update: 2022-05-26

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/clarajegousse/hanoxy . --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/tmpz74mztl_/workflow/Snakefile:
 2    * Absolute path "/'$acc" in line 20:
 3      Do not define absolute paths inside of the workflow, since this renders
 4      your workflow irreproducible on other machines. Use path relative to the
 5      working directory instead, or make the path configurable via a config
 6      file.
 7      Also see:
 8      https://snakemake.readthedocs.io/en/latest/snakefiles/configuration.html#configuration
 9    * Absolute path "/'$acc" in line 21:
10      Do not define absolute paths inside of the workflow, since this renders
11      your workflow irreproducible on other machines. Use path relative to the
12      working directory instead, or make the path configurable via a config
13      file.
14      Also see:
15      https://snakemake.readthedocs.io/en/latest/snakefiles/configuration.html#configuration
16
17Lints for rule download_sample (line 19, /tmp/tmpz74mztl_/workflow/Snakefile):
18    * No log directive defined:
19      Without a log directive, all output will be printed to the terminal. In
20      distributed environments, this means that errors are harder to discover.
21      In local environments, output of concurrent jobs will be mixed and become
22      unreadable.
23      Also see:
24      https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#log-files
25    * Specify a conda environment or container for each rule.:
26      This way, the used software for each specific step is documented, and the
27      workflow can be executed on any machine without prerequisites.
28      Also see:
29      https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#integrated-package-management
30      https://snakemake.readthedocs.io/en/latest/snakefiles/deployment.html#running-jobs-in-containers
31    * Shell command directly uses variable acc from outside of the rule:
32      It is recommended to pass all files as input and output, and non-file
33      parameters via the params directive. Otherwise, provenance tracking is
34      less accurate.
35      Also see:
36      https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#non-file-parameters-for-rules
37    * Shell command directly uses variable acc from outside of the rule:
38      It is recommended to pass all files as input and output, and non-file
39      parameters via the params directive. Otherwise, provenance tracking is
40      less accurate.
41      Also see:
42      https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#non-file-parameters-for-rules

Formatting results

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