tramTMB: Create a tramTMB object

View source: R/tramTMB.R

tramTMBR Documentation

Create a tramTMB object

Description

Create a tramTMB object

Usage

tramTMB(
  data,
  parameters,
  constraint,
  negative,
  map = list(),
  resid = FALSE,
  do_update = FALSE,
  check_const = TRUE,
  no_int = FALSE,
  ...
)

Arguments

data

List of data objects (vectors, matrices, arrays, factors, sparse matrices) required by the user template (order does not matter and un-used components are allowed).

parameters

List of all parameter objects required by the user template (both random and fixed effects).

constraint

list describing the constarints on the parameters

negative

logical, whether the model is parameterized with negative values

map

same as map argument of TMB::MakeADFun

resid

logical, indicating whether the score residuals are calculated from the resulting object

do_update

logical, indicating whether the model should be set up with updateable offsets and weights

check_const

Logical; if TRUE check the parameter constraints before evaluating the returned functions.

no_int

Logical; if FALSE skip the numerical integration step.

...

optional parameters passed to TMB::MakeADFun

Value

A tramTMB object.

Note

The post-estimation parameters are supplied as a part of data


tramME documentation built on July 9, 2023, 7:10 p.m.