snk 0.22.1

No project description provided

SNK (Snek)

---

Documentation: https://snk.wytamma.com

Source Code: https://github.com/Wytamma/snk

---

Snk (pronounced snek) is a Snakemake workflow management system. Snk allows you to install Snakemake workflows as dynamically generated Command Line Interfaces (CLIs). Using a workflow as a CLI increases its interoperability and allows complex workflows to be used as modular components in a larger system.

Installation

pip install snk

Basic Use

Install a workflow as a CLI

Install the dna-seq-gatk-variant-calling workflow (v2.1.1) as variant-calling.

snk install snakemake-workflows/dna-seq-gatk-variant-calling --name variant-calling -t v2.1.1

Successfully installed variant-calling (v2.1.1)!

Inspect the CLI

Snk will automatically create a fully featured CLI for the Snakemake workflow.

variant-calling --help

View run options

Workflow configuration options are automatically generated from the snakemake config file.

variant-calling run --help

Create a DAG

Here we use the .test resources included in the workflow to create the DAG.

variant-calling run -r .test/config -r .test/data --dag dag.pdf

Configure

Snk will dynamically generate config options for the CLI. For example if your config.yaml file has the option fasta: null you can set this option with --fasta.

variant-calling run --fasta example.fa

You can also configure the workflow using a config file.

variant-calling config --pretty # print the config 
variant-calling config > config.yml # save the config 
variant-calling run --config config.yml # run with config 

Read the documentation for more information.

License

snk is distributed under the terms of the MIT license.