Snakemake executor plugin: tes

Warning

No documentation found in repository https://github.com/snakemake/snakemake-executor-plugin-tes. The plugin should provide a docs/intro.md with some introductory sentences and optionally a docs/further.md file with details beyond the auto-generated usage instractions presented in this catalog.

Installation

Install this plugin by installing it with pip or mamba, e.g.:

pip install snakemake-executor-plugin-tes

Usage

In order to use the plugin, run Snakemake (>=8.0) with the corresponding value for the executor flag:

snakemake --executor tes ...

with ... being any additional arguments you want to use.

The executor plugin has the following settings:

Settings

CLI argument	Description	Default	Choices	Required	Type
--tes-url VALUE	URL of TES server	None		✓
--tes-user VALUE	TES username (either specify this or token)	None		✗
--tes-password VALUE	TES password (either specify this or a token)	None		✗
--tes-token VALUE	TES token (either specify this or a user/password)	None		✗