GalaxyParam-class: Class '"GalaxyParam"'

In dtenenba/RGalaxy-vignette-changes: Make an R function available in the Galaxy web platform

Description

Represents information about a parameter to a function that is exposed in Galaxy. Should only be used if the function signature itself does not fully describe the way the parameter should be exposed in Galaxy.

Usage

GalaxyParam(label, min, max, force_select, display,
    checked, size, required=FALSE,
    requiredMsg="This field is required.")

Arguments

label	Required A friendly label for the parameter, if the name of the parameter is not sufficient.
min	The minimum allowed value for the parameter, if the parameter type is numeric or integer.
max	The maximum allowed value for the parameter if the parameter type is numeric or integer.
force_select	Logical. Whether to force user to select an option in the list. Only supplied if the parameter is a select list, that is, a vector of more than one element.
display	If the parameter is a select list, this can be either checkboxes or radio, and determines how to render this parameter in HTML. Default is a drop-down select list.
checked	Logical. If the parameter type is logical, determines whether check box should be checked.
size	If the parameter type is character, this determines the width (in characters) of the resulting text box.
required	Logical. Whether the item is required. If TRUE, the user will be forced by Galaxy to enter a value for this item.
requiredMsg	If required is TRUE and the user tries to run the Galaxy tool without specifying a value for this parameter, this message will be displayed.

Methods

No methods defined with class "GalaxyParam" in the signature.

See Also

link{galaxy}, GalaxyConfig, link{GalaxyOutput}

Examples

    title <- GalaxyParam(required=TRUE, label="Override the default label")

dtenenba/RGalaxy-vignette-changes documentation built on May 15, 2019, 4:54 p.m.