Package 'tmbr'

Title: Analyses Using TMB
Description: Facilitates analyses using 'Template Model Builder'.
Authors: Joe Thorley [aut, cre]
Maintainer: Joe Thorley <[email protected]>
License: MIT + file LICENSE
Version: 0.0.1.9004
Built: 2024-12-01 07:43:13 UTC
Source: https://github.com/poissonconsulting/tmbr

Help Index


Confint

Description

Confint

Usage

## S3 method for class 'tmb_ml_analysis'
confint(
  object,
  parm = terms(object),
  level = getOption("mb.conf_level", 0.95),
  parallel = getOption("mb.parallel", FALSE),
  beep = getOption("mb.beep", FALSE),
  ...
)

Arguments

object

The tmb_ml_analysis object.

parm

A character vector of the terms to get the confidence interval for.

level

A number specifying the confidence level. By default 0.95.

parallel

A flag indicating whether to using parallel backend provided by foreach.

beep

A flag indicating whether to beep on completion of the analysis.

...

Addtional arguments passed to TMB::tmbprofile


Is Converged

Description

Is Converged

Usage

## S3 method for class 'tmb_ml_analysis'
converged(x, ...)

Arguments

x

The object to test convergence for.

...

Unused.


Is a TMB Analysis

Description

Tests whether x is an object of class 'tmb_analysis'

Usage

is.tmb_analysis(x)

Arguments

x

The object to test.

Value

A flag indicating whether the test was positive.


Is a TMB Code

Description

Tests whether x is an object of class 'tmb_code'

Usage

is.tmb_code(x)

Arguments

x

The object to test.

Value

A flag indicating whether the test was positive.


Is a TMB MCMC Analysis

Description

Tests whether x is an object of class 'tmb_mcmc_analysis'

Usage

is.tmb_mcmc_analysis(x)

Arguments

x

The object to test.

Value

A flag indicating whether the test was positive.


Is a TMB ML Analysis

Description

Tests whether x is an object of class 'tmb_ml_analysis'

Usage

is.tmb_ml_analysis(x)

Arguments

x

The object to test.

Value

A flag indicating whether the test was positive.


Is a TMB Model

Description

Tests whether x is an object of class 'tmb_model'

Usage

is.tmb_model(x)

Arguments

x

The object to test.

Value

A flag indicating whether the test was positive.