Skip to content

Commit

Permalink
Update task management docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Dejan Knezevic committed Jan 24, 2019
1 parent 47966b1 commit 330e6af
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1280,7 +1280,7 @@ Task creation hints

Querying tasks
~~~~~~~~~~~~~~
- ``api.files.query`` always return an array of files. For single file inputs, use ``api.files.query(project='my-project', names=["one_file.fa"])[0]``.
- ``api.tasks.query`` always return an array of tasks. For single task inputs, use ``api.tasks.query(project='my-project', names=["one_file.fa"])[0]``.

- Queried tasks can be sorted with the ``order_by`` parameter. Supported fields are ``created_time``, ``start_time``, ``name``, ``end_time``, and ``created_by``.
- Ordering can be specified with the ``order`` parameter. It is set to ``desc`` by default. Ascending order is set with ``asc``.
Expand All @@ -1301,13 +1301,13 @@ Single task
# Project in which I want to run a task.
project = 'my-username/my-project'
# App I want to use to run a task
app = 'my-username/my-project/my-app'
# Inputs
inputs = {}
inputs['FastQC-Reads'] = api.files.query(project='my-project', metadata={'sample': 'some-sample'})
inputs['FastQC-Reads'] = api.tasks.query(project='my-project', metadata={'sample': 'some-sample'})
try:
task = api.tasks.create(name=name, project=project, app=app, inputs=inputs, run=True)
Expand Down Expand Up @@ -1354,21 +1354,23 @@ Batch task
# App to use to run the task
app = 'my-username/my-project/my-app'
# Inputs
inputs = {}
inputs['FastQC-Reads'] = api.files.query(project=project, metadata={'sample': 'some-sample'})
inputs['FastQC-Reads'] = api.tasks.query(project=project, metadata={'sample': 'some-sample'})
# Specify that one task should be created per file (i.e. batch tasks by file).
batch_by = {'type': 'item'}
# Specify that the batch input is FastQC-Reads
batch_input = 'FastQC-Reads'
try:
task = api.tasks.create(name=name, project=project, app=app,
inputs=inputs, batch_input=batch_input, batch_by=batch_by, run=True)
task = api.tasks.create(
name=name, project=project, app=app, inputs=inputs,
batch_input=batch_input, batch_by=batch_by, run=True
)
except SbError:
print('I was unable to run a batch task.')
Expand Down

0 comments on commit 330e6af

Please sign in to comment.