Snakemake workflows as command line utilities
Branch: master
Clone or download
Pull request Compare This branch is 7 commits ahead, 1 commit behind ctb:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cli
test
.gitignore
.travis.yml
LICENSE
MANIFEST.in
README.md
requirements-to-freeze.txt
requirements.txt
setup.py

README.md

2019-snakemake-cli

travis license

An example of a Snakemake command line interface bundled up as an installable Python package.

This example bundles the Snakefile with the command line tool, but this tool can also look in the user's working directory for Snakefiles.

Snakemake functionality is provided through a command line tool called bananas.

Quickstart

This runs through the installation and usage of 2019-snakemake-cli.

Installing bananas

Start by setting up a virtual environment, and install the required packages into the virtual environment:

pip install -r requirements.txt

Now install the bananas command line tool:

python setup.py build install

Now you can run

which bananas

and you should see bananas in your virtual environment's bin/ directory.

Running bananas

Move to the test/ directory and run the tests with the provided config and params files.

Run the hello workflow with Amy params:

rm -f hello.txt
bananas workflow-hello params-amy

Run the hello workflow with Beth params:

rm -f hello.txt
bananas workflow-hello params-beth

Run the goodbye workflow with Beth params:

rm -f goodbye.txt
bananas workflow-goodbye params-beth

Details

The entrypoint of the command line interface is the main() function of cli/command.py.

The location of the Snakefile is cli/Snakefile.

An alternative arrangement would be for users to provide a Snakefile via rules in the working directory, or via a Github URL or a remote URL.

Tags

  • v1.0 - initial version, ctb/2018-snakemake-cli

  • v2.0 - Snakemake workflow bundled as installable Python package, Snakefile bundled with Python package, command line interface provided to wrap Snakemake API call