Summary method for class "hammel_fertility"
Arguments
- object
A
hammel_fertilityobject returned byfertility().- ...
Additional arguments, currently unused.
- x
A
summary.hammel_fertilityobject returned bysummary.hammel_fertility().
Value
summary() returns an object of class summary.hammel_fertility containing:
- birth_interval
The minimum maternal birth-to-birth interval, in years.
- ffab
The probability that a newborn is female.
- rate_strata
A list describing the input rate schedule, containing
stratified_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.- open_band_non_zero
Whether any age band ends at
Infand has a positive fertility rate.
Examples
process <- fertility(usa_2000_fertility)
summary(process)
#>
#> ── Fertility process ──
#>
#> • Minimum birth interval: 0.75 years
#> • Fraction female at birth: 0.4886
#> • Stratified by: none
#> • Age bands (years): [15, 20), [20, 25), [25, 30), [30, 35), [35, 40), [40, 45)
#> • Weight model: none
