reorganise_matrices: Reorganise Matrix Population Models

In mpmsim: Simulation of Matrix Population Models with Defined Life History Characteristics

Reorganise Matrix Population Models

Description

This function reorganises a list of matrix population models, which are split into mat_A, mat_U, mat_F, and optionally mat_C sub-matrices. It prepares the matrices for easy conversion into a compadreDB object.

Usage

reorganise_matrices(matrix_list)

Arguments

matrix_list

A list of lists, where each sub-list contains the matrices mat_A, mat_U, mat_F, and optionally mat_C.

Details

This function processes a list of matrix population models, extracting and grouping the sub-matrices (mat_A, mat_U, mat_F, and optionally mat_C) into separate lists. If a mat_C matrix is not present in a model, an NA matrix of the same size as mat_U is used as a placeholder.

Value

A list containing four elements: mat_A, mat_U, mat_F, and mat_C. Each element is a list of matrices corresponding to the respective matrix type from the input. If mat_C does not exist in a sub-list, it is replaced with an NA matrix of the same dimensions as mat_U.

Author(s)

Owen Jones [e-mail]

See Also

Other Leslie matrices: make_leslie_mpm(), rand_leslie_set()

Examples

# Example usage
matrix_list <- list(
  list(
    mat_A = matrix(1, 2, 2),
    mat_U = matrix(2, 2, 2),
    mat_F = matrix(3, 2, 2),
    mat_C = matrix(4, 2, 2)
  ),
  list(
    mat_A = matrix(5, 2, 2),
    mat_U = matrix(6, 2, 2),
    mat_F = matrix(7, 2, 2)
  )
)
reorganised_matrices <- reorganise_matrices(matrix_list)
reorganised_matrices$mat_A

mpmsim documentation built on June 8, 2025, 10 a.m.