gx.analysis: Execute analysis using one of the integrated tools

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

Execute analysis using one of the integrated tools

Description

This function invokes an analysis tool with specified parameters.

Usage

gx.analysis(analysisName, parameters = list(), wait = T, verbose = T)

Arguments

analysisName	name of analysis tool
parameters	parameters to configure the analysis
wait	TRUE to wait for the analysis to complete. Default: TRUE
verbose	TRUE to see some progress info. Default: TRUE

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). The function gx.analysis.parameters shows available parameters for an analysis tool and gx.analysis.list lists the available tools.

Value

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

See Also

gx.analysis.list

gx.analysis.parameters

biouml.analysis

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