summarise_mpms: Summarise Matrix Population Models

View source: R/summarise_mpms.R

summarise_mpmsR Documentation

Summarise Matrix Population Models

Description

Calculates and summarises various metrics from matrix population models (MPMs) including dimension (= age in Leslie matrices), lambda values, maximum fecundity values, maximum growth/survival transition probabilities, and minimum non-zero growth/survival transition probabilities

Usage

summarise_mpms(x)

Arguments

x

A compadreDB object containing matrix population models, typically in a format compatible with matA, matU, and matF functions.

Value

This function prints summaries of the following metrics:

  • lambda values: The lambda values (dominant eigenvalues) of the A matrices.

  • max F values: The maximum values from the F matrices.

  • max U values: The maximum values from the U matrices.

  • minimum non-zero U values: The minimum non-zero values from the U matrices.

See Also

Other utility: plot_matrix()

Examples

mats <- rand_lefko_set(
  n = 10, n_stages = 5, fecundity = c(0, 0, 4, 8, 10),
  archetype = 4, output = "Type1"
)

summarise_mpms(mats)

mpmsim documentation built on April 4, 2025, 4:57 a.m.