array.param: array.param

Description Usage Arguments Details Value Author(s) Examples

View source: R/params.R

Description

Create an Array AnalysisPageParam

Usage

1

Arguments

...

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

prototype

A single AnalysisPageParam that is the prototype for each of the elements in the array. Note that while only one param is allowed, it could potentially be either a compound or another array parameter.

start

The starting length of the array that should be rendered

min

The minimum allowed length of the array. Buttons to remove elements should be de-activated below this level (default 0).

max

The maximum allowed length of the array. Buttons to add elements should be de-activated above this level (default Inf).

Details

An array AnalysisPageParam is a way of having a single parameter with multiple repetitions of some other (fixed) parameter type. The starting length, as well as minimum and maximum allowable lengths, are provided. If min != max then the front end should render some widget to add/remove elements.

By combining with compound.param a fairly complex data structure can now be specified.

Value

AnalysisPageParam of type "array"

Author(s)

Brad Friedman

Examples

1
2
  one.gene <- simple.param(name="gene", label="Gene Symbol")
  gene.set <- array.param(name="geneset", prototype=one.gene)

AnalysisPageServer documentation built on April 28, 2020, 6:32 p.m.