Extract supplied metafounder group assignments — metafounder

Usage

metafounder_groups(object, ...)

Arguments

object: A fitted model object.
...: Reserved for future arguments.

Value

A data frame with columns id, metafounder_group, and is_metafounder. Rows are animals, keyed by id; is_metafounder flags animals whose unknown-parent slot carries a supplied group label, not metafounders themselves. The metafounders are the pseudo-populations that are the rows and columns of gamma_matrix().

Details

metafounder_groups() returns the ID-keyed metafounder group assignments carried by an experimental metafounder or H^Gamma single-step hsquared_fit object. These assignments are provenance for the supplied relationship, not estimated grouping parameters.