Skip to contents

Summary method for class "hammel_group_inheritance"

Usage

# S3 method for class 'hammel_group_inheritance'
summary(object, ...)

# S3 method for class 'summary.hammel_group_inheritance'
print(x, ...)

Arguments

object

A hammel_group_inheritance object returned by group_inheritance().

...

Additional arguments, currently unused.

x

A summary.hammel_group_inheritance object returned by summary.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; otherwise NULL.

passing

For "hierarchy", the probability of reversing the order; otherwise NULL.

fixed_value

For "fixed", the category every newborn receives; otherwise NULL.

Examples

summary(group_inheritance("hierarchy", order = c("B", "W"), passing = 0.05))
#> 
#> ── Group inheritance model ──
#> 
#> • Method: hierarchy
#> • Order: B > W
#> • Passing probability: 0.05