Summary method for class "hammel_union_formation"
Arguments
- object
A
hammel_union_formationobject returned byunion_formation().- ...
Additional arguments, currently unused.
- x
A
summary.hammel_union_formationobject returned bysummary.hammel_union_formation().
Value
summary() returns an object of class summary.hammel_union_formation
containing:
- method
The union initiation method:
"rate"or"on_demand".- min_male_age
The minimum eligible male age, in years.
- kinship_generations
The configured number of generations used for kinship exclusion when selecting partners.
- cancel_birth_if_no_match
Whether a birth is cancelled when its on-demand partner search or rate-mode nonmarital father selection fails, rather than occurring with an unknown father.
- cohab_as_previous_union
Whether cohabitations count as previous unions when determining previous-union status.
- rate_strata
A list describing the union-search rate schedule, or
NULLwhen no rate schedule is configured. The list containsstratified_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).- cohabitation
NULLwhen cohabitation is disabled; otherwise a list containingcohab_prob_range(the minimum and maximum supplied cohabitation probabilities),cohab_rate_strata(strata and bands of the cohabitation probability schedule),convert_rate_strata(strata and bands of the conversion rate schedule, orNULLwhen no conversion schedule is configured),matching(a summary of the cohabitation matching model, orNULLwhen the general matching model is used) andconversion_weights(a summary of the conversion weight model, orNULLwhen unweighted). Both schedule summaries use the same structure asrate_strata.- matching
A summary of the matching model: a
summary.hammel_matching_model, or a list ofperiodsandmodelsfor a calendar schedule.- father_matching
A summary of the matching model for fathers of unpartnered births, as for
matching, orNULLwhen the general matching model is used.- search_weights
A summary of the weight model choosing which woman searches: a
summary.hammel_weight_model, a list ofperiodsandmodelsfor a calendar schedule, orNULLwhen searching women are selected without weights.
Examples
process <- union_formation("rate", usa_2000_marriage)
summary(process)
#>
#> ── Union formation process ──
#>
#> • Search method: rate
#> • Stratified by: none
#> • Age bands (years): [15, 20), [20, 25), [25, 30), ..., [65, 70), [70, Inf) (12
#> bands; showing 5)
#> • Search weight model: none
#> • Matching model: ~age_difference + I(age_difference^2)
#> • Coefficients: age_difference = 0, I(age_difference^2) = -0.02773
#> • Preferred age gap: 0 years
#> • Half-weight distance: 5 years
#> • Father matching model: same as matching model
#> • Births without a matched father: cancelled
#> • Male eligibility restrictions
#> • Minimum male age: 15
#> • Generational proximity: 2
#> • Cohabitation: disabled
