integer_range_parameter: Define a integer range parameter

Description Usage Arguments See Also Examples

View source: R/param_integer_range.R

Description

Define a integer range parameter

Usage

1
2
3
4
5
6
7
8
integer_range_parameter(
  id,
  default,
  lower_distribution,
  upper_distribution,
  description = NULL,
  tuneable = TRUE
)

Arguments

id

The name of the parameter.

default

The default value of the parameter.

lower_distribution

A distribution from which the lower value of the range can be sampled.

upper_distribution

A distribution from which the upper value fo the range 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
integer_range_parameter(
  id = "ks",
  default = c(3L, 15L),
  lower_distribution = uniform_distribution(1L, 5L),
  upper_distribution = uniform_distribution(10L, 20L),
  description = "The numbers of clusters to be evaluated."
)

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