
Summarize a group inheritance model
Source:R/group_inheritance.R
summary.hammel_group_inheritance.RdSummary method for class "hammel_group_inheritance"
Arguments
- object
A
hammel_group_inheritanceobject returned bygroup_inheritance().- ...
Additional arguments, currently unused.
- x
A
summary.hammel_group_inheritanceobject returned bysummary.hammel_group_inheritance().
Value
summary() returns an object of class summary.hammel_group_inheritance
containing:
- method
The inheritance method.
- order
For
"hierarchy", the group labels, highest-ranked first; otherwiseNULL.- passing
For
"hierarchy", the probability of reversing the order; otherwiseNULL.- fixed_value
For
"fixed", the category every newborn receives; otherwiseNULL.
Examples
summary(group_inheritance("hierarchy", order = c("B", "W"), passing = 0.05))
#>
#> ── Group inheritance model ──
#>
#> • Method: hierarchy
#> • Order: B > W
#> • Passing probability: 0.05