logical_parameter: Define a logical parameter

Description Usage Arguments See Also Examples

View source: R/param_logical.R

Description

Define a logical parameter

Usage

1
logical_parameter(id, default, description = NULL, tuneable = TRUE)

Arguments

id

The name of the parameter.

default

The default value of the parameter.

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
logical_parameter(
  id = "scale",
  default = TRUE,
  description = "Whether or not to scale the input variables"
)

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