
Summarize a group transition process
Source:R/group_transition.R
summary.hammel_group_transition.RdSummary method for class "hammel_group_transition"
Arguments
- object
A
hammel_group_transitionobject returned bygroup_transition().- categories
Optional character vector of the dimension's categories, used to count possible transitions.
NULL(default) uses the categories that appear in theoriginordestinationcolumns.- ...
Additional arguments, currently unused.
- x
A
summary.hammel_group_transitionobject returned bysummary.hammel_group_transition().
Value
summary() returns an object of class summary.hammel_group_transition
containing:
- group
The name of the group dimension whose categories change, or
NULLwhen the process applies to the model's only dimension.- categories
The categories used to define possible transitions.
- transitions
A tibble of the
originanddestinationpairs that have a positive rate in at least one band or stratum.- missing_transitions
A tibble of the possible
originanddestinationpairs between distinct categories that have no positive rate in any band or stratum.- rate_strata
A list describing the transition rate schedule apart from its
originanddestinationcolumns, containingstratified_by(stratum column names),strata(a tibble of observed stratum combinations),bands(a tibble of exact band combinations), andbands_by_stratum(whether band combinations differ by stratum). Shared bands are stored once; otherwisebandsincludes the stratum columns. Band endpoints define half-open intervals[start, end).- weights
A summary of the weight model used for selection within rate cells: a
summary.hammel_weight_model, a list ofperiodsandmodelsfor a calendar schedule, orNULLwhen selection is unweighted.- age_independence
The household age of independence, in years, or
NULLwhen transitions move individuals rather than households.
Examples
rates <- tibble::tribble(
~age_start, ~age_end, ~origin, ~destination, ~rate,
0, Inf, "A", "B", 0.05,
0, Inf, "B", "A", 0.02
)
process <- group_transition(rates, household = household())
summary(process)
#>
#> ── Group transition process ──
#>
#> • Group dimension: the model's only dimension
#> • Transitions (2 of 2 possible): A → B, B → A
#> • Missing transitions: none
#> • Stratified by: none
#> • Age bands (years): [0, Inf)
#> • Household moves: yes, age of independence 18 years
#> • Weight model: none