pipeline_details: Returns the details of a pipeline for a project

In road2stat/sbgr: R Client for Seven Bridges Genomics API (v1)

Description

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

Usage

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

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

road2stat/sbgr documentation built on March 9, 2021, 4:33 a.m.