subset_parameter {dynparam}R Documentation

Define a subset parameter

Description

Define a subset parameter

Usage

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

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)"
)

[Package dynparam version 1.0.2 Index]