create_pm: Creates a Skeleton Paramnames Object for Use in...

View source: R/RcppExports.R

create_pmR Documentation

Creates a Skeleton Paramnames Object for Use in Function-based Modeling

Description

Creates a simple skeleton paramnames object that can be entered as input in functions flefko2(), flefko3(), and aflefko2().

Usage

create_pm(name_terms = FALSE)

Arguments

name_terms

A logical value indicating whether to start each variable name as none if FALSE, or as the default modelparams name if TRUE. Defaults to FALSE.

Value

A three column data frame, of which the first describes the parameters in reasonably plain English, the second gives the name of the parameter within the MPM generating functions, and the third is to be edited with the names of the variables as they appear in the models.

Notes

The third column in the resulting object should be edited with the names only of those variables actually used in vital rate modeling. This paramnames object should apply to all models used in a single MPM building exercise. So, for example, if the models used include random terms, then they should all have the same random terms. Fixed terms can vary, however.

Examples

our_pm <- create_pm()
our_pm


lefko3 documentation built on Oct. 14, 2023, 1:07 a.m.