CompadreMatrixMethods: Methods for working with matrices in com(p)adre

CompadreMatrixMethodsR Documentation

Methods for working with matrices in com(p)adre

Description

This page describes methods for accessing any matrix information from CompadreMat and CompadreDB objects.

Most methods for working with matrices are applicable to both CompadreMat and CompadreDB objects. These are described on this page (along with a couple) of methods applicable to only CompadreMat or CompadreDB objects).

Usage

matA(object)

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

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

## S4 method for signature 'list'
matA(object)

matU(object)

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

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

## S4 method for signature 'list'
matU(object)

matF(object)

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

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

## S4 method for signature 'list'
matF(object)

matC(object)

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

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

## S4 method for signature 'list'
matC(object)

matrixClass(object)

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

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

## S4 method for signature 'list'
matrixClass(object)

MatrixClassAuthor(object)

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

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

## S4 method for signature 'list'
MatrixClassAuthor(object)

MatrixClassOrganized(object)

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

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

## S4 method for signature 'list'
MatrixClassOrganized(object)

MatrixClassNumber(object)

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

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

## S4 method for signature 'list'
MatrixClassNumber(object)

Arguments

object

A CompadreDB object

Slots

matA

A matrix population model (i.e. a square projection matrix)

matU

The survival component of a matrix population model (i.e. a square projection matrix reflecting survival-related transitions; e.g. progression, stasis, and retrogression)

matF

The sexual component of a matrix population model (i.e. a square projection matrix reflecting transitions due to sexual reproduction)

matC

The clonal component of a matrix population model (i.e. a square projection matrix reflecting transitions due to clonal reproduction)

matrixClass

A data frame with columns MatrixClassOrganized (elements are "active", "prop", or "dorm") MatrixClassAuthor (the matrix author's stage description), and MatrixClassNumber (integer stage number)


jonesor/Rcompadre documentation built on Jan. 16, 2024, 12:48 a.m.