integer_parameter: Define a integer parameter

Description Usage Arguments See Also Examples

View source: R/param_integer.R

Description

Define a integer parameter

Usage

1
2
integer_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
integer_parameter(
  id = "k",
  default = 5,
  distribution = uniform_distribution(3, 10),
  description = "The number of clusters."
)

integer_parameter(
  id = "num_iter",
  default = 100,
  distribution = expuniform_distribution(10, 10000),
  description = "The number of iterations."
)

dynparam documentation built on May 1, 2019, 7:56 p.m.