dynparam (version 1.0.2)

character_parameter: Define a character / string parameter

Description

Define a character / string parameter

Usage

character_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

# NOT RUN {
character_parameter(
  id = "method",
  default = "pearson",
  values = c("pearson", "spearman", "kendall"),
  description = "Which correlation coefficient to compute."
)
# }