mpm_methods: Extract stage-class information from CompadreMat or...

In Rcompadre: Utilities for using the 'COM(P)ADRE' Matrix Model Database

Extract stage-class information from CompadreMat or CompadreDB objects

Description

Methods for extracting stage-class information from CompadreMat or CompadreDB objects, including whether the matrix population model includes one or more propagule stages (mpm_has_prop), dormant stages (mpm_has_dorm), or active stages (mpm_has_active), and the integer index of the first active stage class (mpm_first_active).

These methods will return a single value if passed a CompadreMat object, or a vector of values if passed a CompadreDB object (one value for every CompadreMat object within the column 'mat').

Usage

mpm_has_prop(object)

## S4 method for signature 'CompadreMat'
mpm_has_prop(object)

## S4 method for signature 'CompadreDB'
mpm_has_prop(object)

mpm_has_active(object)

## S4 method for signature 'CompadreMat'
mpm_has_active(object)

## S4 method for signature 'CompadreDB'
mpm_has_active(object)

mpm_has_dorm(object)

## S4 method for signature 'CompadreMat'
mpm_has_dorm(object)

## S4 method for signature 'CompadreDB'
mpm_has_dorm(object)

mpm_first_active(object)

## S4 method for signature 'CompadreMat'
mpm_first_active(object)

## S4 method for signature 'CompadreDB'
mpm_first_active(object)

Arguments

object

A CompadreMat or CompadreDB object

Value

No return value, called for side effects

Author(s)

Patrick Barks <[e-mail]>

See Also

Other data checking: cdb_check_species(), cdb_collapse(), cdb_compare(), cdb_flag()

Examples

# with CompadreMat object
mpm_has_prop(Compadre$mat[[1]])
mpm_has_active(Compadre$mat[[1]])
mpm_has_dorm(Compadre$mat[[1]])
mpm_first_active(Compadre$mat[[1]])

# with CompadreDB object
mpm_has_prop(Compadre)
mpm_has_active(Compadre)
mpm_has_dorm(Compadre)
mpm_first_active(Compadre)

Rcompadre documentation built on Oct. 17, 2024, 1:07 a.m.