subset_parameter: Define a subset parameter

Description Usage Arguments See Also Examples

View source: R/param_subset.R

Description

Define a subset parameter

Usage

1
subset_parameter(id, default, values, description = NULL, tuneable = TRUE)

Arguments

id

The name of the parameter.

default

The default value of the parameter.

values

A set of possible values.

description

An optional (but recommended) description of the parameter.

tuneable

Whether or not a parameter is tuneable.

See Also

dynparam for an overview of all dynparam functionality.

Examples

1
2
3
4
5
6
subset_parameter(
  id = "dimreds",
  default = c("pca", "mds"),
  values = c("pca", "mds", "tsne", "umap", "ica"),
  description = "Which dimensionality reduction methods to apply (can be multiple)"
)

dynparam documentation built on Jan. 5, 2021, 1:06 a.m.