Snakemake Pipelines
Introduction
This page explains how to run the OmicsBox Engine pipelines with Snakemake. For the list of pipelines and their requirements, see Pipelines.
In preparation
Snakemake versions of the pipelines are being added progressively. Check the available pipelines for the ones you can already run with Snakemake.
In the commands below, replace <workflow> with the identifier of a pipeline, for example functional_annotation.
Run a pipeline
Get a local copy of the repository:
git clone https://github.com/BioBam/omicsbox-engine-workflows.git
cd omicsbox-engine-workflows
-
Export the configuration template. This writes
<workflow>.config.yamlto the current folder, without starting any analysis:snakemake -s snakemake/workflows/<workflow>/Snakefile dump_config --cores 1 -
Edit
<workflow>.config.yaml: set the input files and the output folder, and adjust the options you need. Each option has a comment with its accepted values and its default. Uncomment a line to enable that option. -
Run the pipeline with your configuration:
snakemake -s snakemake/workflows/<workflow>/Snakefile \ --configfile <workflow>.config.yaml \ --cores 4
To change a single setting without editing the file, add it with --config, for example --config input_fasta=/data/sequences.fasta. A value given with --config overrides the same value in your configuration file.
Results
Results are saved in <local_folder>/<run_id>/. By default, local_folder is results and run_id is the pipeline identifier. Set run_id in your configuration to give each run its own results folder.
More information
The repository wiki describes each pipeline in detail.