Skip to content

Commit

Permalink
more doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
SooLee committed Jun 10, 2019
1 parent d633396 commit ab89fb0
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/execution_json.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,12 @@ Shell command-specific

:command:
- <shell command to be executed inside the Docker container>
- a pair of nested double quotes are allowed
- (e.g.

::

"command": "echo \"haha\" > outfile"


Snakemake-specific
Expand All @@ -138,6 +144,23 @@ Snakemake-specific
- It is highly recommended to use the official Snakemake Docker image
(``quay.io/snakemake/snakemake``)

:command:
- This is a required field.
- Most likely it will be ``snakemake`` but it can be run with other ``snakemake`` otions.
- (e.g.

::

"command": "snakemake <target> --use-conda"

- a pair of nested double quotes are allowed
- (e.g.

::

"command": "snakemake <target> --config=region=\"22:30000000-40000000\"


:snakemake_main_filename:
- This is a required field.
- Most likely it will be ``Snakefile`` (do not include directory name).
Expand Down

0 comments on commit ab89fb0

Please sign in to comment.