AnalysisPageServer (version 1.6.2)

compound.param: compound.param

Description

Create a Compound AnalysisPageParam

Usage

compound.param(..., children)

Arguments

...

Passed through to simple.param. This includes at least "name", optionally "label" and "description". but not "type" (which is set to "compound") or "value" (which is set to empty string, but ignored anyway, since each of the contained parameters will have its own value).

children

AnalysisPageParamSet An AnalysisPageParamSet representing all of the nested parameters

Value

AnalysisPageParam of type "compound"

Details

A compound AnalysisPageParam is a single parameter that has multiple parts. The parts are represented by an AnalysisPageParamSet, so could be arbitrarily nested. The front end is responsible for wrapping up all of the values in a JSON hash and passing in a single value.

This can be thought of as a way of building a hash out of other parameter types.

Examples

plist <- list(simple.param(name="study"), simple.param(name="comp"), simple.param("feature.type", value="gene"))
  comp <- compound.param(name="comp", label="Comparison", children=param.set(plist))