gx.workflow: Executes workflow with specified parameters

In genexplain/geneXplainR: An R interface for the geneXplain platform

Executes workflow with specified parameters

Description

This function invokes a workflow with specified parameters. A workflow is identified by its path in the platform workspace, e.g. many workflows are provided under analyses/Workflows.

Usage

gx.workflow(path, parameters = list(), wait = T, verbose = T)

Arguments

path	platform path to the workflow
parameters	workflow parameters
wait	set true to wait for task to complete
verbose	switch to get more or less progress info

Details

The function can wait for the analysis to complete (default) or just invoke the analysis asynchronously. In the latter case it may be desireable to keep the platform job id, which is returned by this function, to be able to request the job status. Analysis progress can be observed by setting verbose=T (default). Currently there is no workflow complement for gx.analysis.parameters to inspect workflow parameters. Workflow parameters are specified as shown in the platform web interface and parameter names can be listed using gx.ls, but the output also contains other elements besides analysis parameters.

Value

the job id of submitted task. The job id can be used to retrieve information about the status of the analysis.

See Also

gx.analysis

gx.ls

biouml.workflow

genexplain/geneXplainR documentation built on Oct. 24, 2023, 8:56 a.m.