input: Create SSM input

Description Usage Arguments See Also Examples

View source: R/input.r

Description

Create an input parameter for SSM

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
input(
  name,
  description = NULL,
  value = NULL,
  prior = NULL,
  transformation = NULL,
  to_resource = NULL,
  sde = NULL,
  tag = c("none", "remainder", "pop_size")
)

Arguments

name

character, name of the input

description

character, description of the input

value

numeric, define the value of the input. Forced inputs can be specified by a named numeric vector with dates as names.

prior

define the prior of the input, as returned by a prior helper

transformation

define the transformation of the input (see example)

to_resource

define the back-transformation of the input. In order to make predictions after fitting your data, specify how to invert the transformation relation at a later time than t0.

sde

define a stochastic differential equation on the input (see example)

tag

character, tag for specific inputs. Set to one among:

  • "remainder" if the population size is assumed constant, the tagged state variable will be used as a remainder (see example)

  • "pop_size" if the population size is assumed constant, the tagged parameter will be used to set the population size

See Also

prior

Examples

1
2
3
4
## Not run: 
 TODO

## End(Not run)

StateSpaceModels/ssminr documentation built on Feb. 7, 2020, 8:20 p.m.