getPkgPipelineInfo: Get info for 'shmootl' pipelines.
In gact/shmootl: QTL Analysis Utilities for Yeast

Description Usage Arguments Details Value

This function interrogates the function definition and documentation for the specified pipelines and returns the resulting information as a list. Each element of this list is another list containing information for a specific pipeline, the elements of which are as follows:

1	getPkgPipelineInfo(pipelines = NULL)

pipelines

Names of one or more shmootl pipelines for which info should be retrieved. If none are specified, pipeline info is returned for all pipelines.

'command' Shell command used to call pipeline.
'title' Pipeline function title.
'group' Category to which the pipeline belongs.
'description' Pipeline function description. This is not returned if it duplicates the function title.
'details' Pipeline function details.
'params' A data.frame containing pipeline function parameter info. If the function has no parameters, this takes a NULL value.

Elements 'command', 'title', and 'group' are guaranteed to contain their respective values. The remaining elements are only returned if corresponding documentation is available; otherwise, they are assigned a NULL value.

A list of list objects, each containing info for a specific shmootl pipeline.

gact/shmootl documentation built on Nov. 11, 2021, 6:23 p.m.