numeric_parameter: Define a numeric parameter

Description Usage Arguments See Also Examples

View source: R/param_numeric.R

Description

Define a numeric parameter

Usage

1
2
3
4
5
6
7
numeric_parameter(
  id,
  default,
  distribution,
  description = NULL,
  tuneable = TRUE
)

Arguments

id

The name of the parameter.

default

The default value of the parameter.

distribution

A distribution from which the parameter can be sampled.

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
 7
 8
 9
10
11
12
13
numeric_parameter(
  id = "alpha",
  default = 0.5,
  distribution = uniform_distribution(0.0, 1.0),
  description = "Weighting parameter for distance function."
)

numeric_parameter(
  id = "beta",
  default = 0.001,
  distribution = expuniform_distribution(1e-4, 1e-1),
  description = "Percentage decrease in age per iteration"
)

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