pipeline_details: Returns the details of a pipeline for a project

Description Usage Arguments Details Value Examples

Description

Returns the details of a pipeline (runtime and regular parameters, description etc.) for a project.

Usage

1
2
pipeline_details(auth_token = NULL, project_id = NULL, pipeline_id = NULL,
  ...)

Arguments

auth_token

auth token

project_id

ID of a project you want to access.

pipeline_id

ID of a pipeline you want to access.

...

parameters passed to sbgapi function

Details

When using the API to run a task, the user needs to set input files for all input nodes. To facilitate this, some pipeline input nodes may contain field "suggested files", that contains files which may be used as default input (reference genomes, SNP database, etc.).

Value

parsed list of the returned json

Examples

1
2
3
4
token = '420b4672ebfc43bab48dc0d18a32fb6f'
req = pipeline_details(token,
            project_id = 'b0b3a611-6bb0-47e5-add7-a83402cf7858',
            pipeline_id = '55606ad4896a5d524656afd0')

sbgr documentation built on Oct. 5, 2016, 4:14 a.m.

Search within the sbgr package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.

Please suggest features or report bugs in the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.