Skip to content

Commit 7ae0dc6

Browse files
authored
Merge pull request #1184 from simonbray/docs-fix
Fix documentation to include `--download_outputs` flag
2 parents bacca17 + 407f96b commit 7ae0dc6

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/_running_external.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ If you want to set the name of the history in which the workflow executes, add
2222
``--history_name NAME`` to the command. You should be able to see the workflow
2323
executing in the web browser, if you navigate to the 'List all histories' view.
2424
If you prefer to download data without interacting with the web interface at all,
25-
you can add ``--output_directory`` and ``--output_json`` to the command as
26-
before.
25+
you can add ``--download_outputs --output_directory . --output_json output.json``
26+
to the command as before.
2727

2828
Typing ``--engine external_galaxy --galaxy_url SERVER_URL --galaxy_user_key YOUR_API_KEY``
2929
each time you want to execute a workflow is a bit annoying. Fortunately, Planemo

docs/_running_intro.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,16 +48,16 @@ achieved with the command
4848

4949
::
5050

51-
$ planemo run tutorial.ga tutorial-job.yml --output_directory . --output_json output.json
51+
$ planemo run tutorial.ga tutorial-job.yml --download_outputs --output_directory . --output_json output.json
5252

5353

5454
You can optionally (and probably should) add the ``--galaxy_root`` flag with
5555
the location of a local copy of the Galaxy source code, which will allow the
5656
instance to be spun up considerably faster.
5757

58-
Note that the ``--output_directory`` and ``--output_json`` flags are optional,
59-
but allow saving the output to a local file. The contents should be something
60-
like:
58+
Note that ``--download_outputs --output_directory . --output_json output.json``
59+
is optional, but allow saving the output to a local file. The contents should
60+
be something like:
6161

6262
::
6363

@@ -76,7 +76,7 @@ significantly longer to complete than the previous command.
7676

7777
::
7878

79-
$ planemo run tutorial.ga tutorial-job.yml --output_directory . --output_json output.json --engine docker_galaxy --ignore_dependency_problems
79+
$ planemo run tutorial.ga tutorial-job.yml --download_outputs --output_directory . --output_json output.json --engine docker_galaxy --ignore_dependency_problems
8080

8181

8282
This introduces the concept of an engine, which Planemo provides to allow

0 commit comments

Comments
 (0)