SpaDES (version 1.0.1)

defineParameter: Define a parameter used in a module

Description

Used to specify a parameter's name, value, and set a default.

Usage

defineParameter(name, class, default, min, max, desc)

## S3 method for class 'character,character,ANY,ANY,ANY,character':
defineParameter(name,
  class, default, min, max, desc)


  ## S3 method for class 'character,character,ANY,missing,missing,character':
defineParameter(name,
  class, default, desc)

Arguments

name

Character string giving the parameter name.

class

Character string giving the parameter class.

default

The default value to use when none is specified by the user. Non-standard evaluation is used for the expression.

min

With max, used to define a suitable range of values. Non-standard evaluation is used for the expression.

max

With min, used to define a suitable range of values. Non-standard evaluation is used for the expression.

desc

Text string providing a brief description of the parameter.

Value

• data.frame

Examples

parameters = rbind(
  defineParameter("lambda", "numeric", 1.23, desc="intrinsic rate of increase"),
  defineParameter("p", "numeric", 0.2, 0, 1, "probability of attack")
)