Snakemake executor plugin: tes

https://img.shields.io/badge/repository-github-blue?color=%23022c22 https://img.shields.io/badge/author-Sven%20Twardziok-purple?color=%23064e3b PyPI - Version PyPI - License

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 instructions 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.

Settings

The executor plugin has the following settings (which can be passed via command line, the workflow or environment variables, if provided in the respective columns):

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