
Package index
Model setup and simulation
Construct a model, attach its population and processes, and run a simulation.
-
hammelhammel-package - hammel: Continuous-Time Demographic Microsimulation
-
hammel_model() - Create an empty Hammel model specification
-
summary(<hammel_model>)print(<summary.hammel_model>) - Summarize a Hammel model
-
set_population() - Set the starting population of a Hammel model
-
group()set_groups() - Describe and declare a group dimension
-
set_process() - Set a demographic process specification
-
run_simulation() - Run a demographic simulation
Population preparation
Create and validate starting populations and describe their group dimensions.
-
hammel_population() - Create a Hammel population
-
summary(<hammel_population>)print(<summary.hammel_population>) - Summarize a Hammel population
-
generate_uniform_population() - Generate a population with uniformly distributed ages
-
validate_population() - Validate a Hammel population
-
group()set_groups() - Describe and declare a group dimension
-
summary(<hammel_group>)print(<summary.hammel_group>) - Summarize a group dimension
-
get_mortality_hmd() - Download prepared mortality rates from the HMD
-
get_fertility_hfd() - Download prepared fertility rates from the HFD
-
stratify_rates() - Add proportional strata to a rate table
-
mortality()set_mortality() - Specify an age-specific mortality process
-
summary(<hammel_mortality>)print(<summary.hammel_mortality>) - Summarize a mortality process
-
fertility()set_fertility() - Specify an age-specific fertility process
-
summary(<hammel_fertility>)print(<summary.hammel_fertility>) - Summarize a fertility process
-
union_formation()set_union_formation() - Specify a union-formation process
-
summary(<hammel_union_formation>)print(<summary.hammel_union_formation>) - Summarize a union formation process
-
union_dissolution()set_union_dissolution() - Specify duration-dependent union dissolution
-
summary(<hammel_union_dissolution>)print(<summary.hammel_union_dissolution>) - Summarize a union dissolution process
-
group_transition()set_group_transition() - Specify individual group transitions
-
summary(<hammel_group_transition>)print(<summary.hammel_group_transition>) - Summarize a group transition process
-
household() - Define who moves together in household transitions
Matching, inheritance, and weight models
Configure partner selection, newborn group inheritance, and selection within rate cells.
-
matching_model() - Specify a conditional-logit matching model
-
age_gap_matching_model() - Create a quadratic matching model from interpretable age-gap preferences
-
summary(<hammel_matching_model>)print(<summary.hammel_matching_model>) - Summarize a matching model
-
group_inheritance() - Specify newborn group identity inheritance
-
summary(<hammel_group_inheritance>)print(<summary.hammel_group_inheritance>) - Summarize a group inheritance model
-
weight_model() - Create a weight model for selection within rate cells
-
summary(<hammel_weight_model>)print(<summary.hammel_weight_model>) - Summarize a weight model
Demographic summaries
Calculate population sizes, observed event rates, and synthetic demographic measures.
-
calculate_population_size() - Calculate the living population at time points
-
calculate_mortality_rates()calculate_fertility_rates()calculate_union_rates()calculate_marriage_rates()calculate_dissolution_rates()calculate_cohab_convert_rate()calculate_transition_rates() - Calculate observed demographic event rates
-
calculate_life_table() - Construct period life tables from age-specific mortality rates
-
calculate_life_expectancy() - Calculate life expectancy at given ages
-
calculate_tfr()calculate_patfr() - Calculate total fertility and parity-adjusted total fertility rates
Family and union histories
Extract kin relationships and enrich recorded person, birth, and union histories.
-
extract_kin() - Extract known kin within generation-distance bounds
-
count_kin() - Calculate the average number of living kin over time
-
augment_persons() - Extract persons data from simulation results with additional detail
-
augment_unions() - Extract union data from simulation results with additional detail
-
extract_unpartnered_births() - Extract births with known parents to unpartnered mothers
-
usa_2000_mortalityusa_2000_fertilityusa_2000_fertility_unionusa_2000_marriageusa_2000_migration - United States example rates, around 2000
-
england_wales_1992_onward - England and Wales inputs for a second demographic transition example
-
niger_fertility - Age-specific fertility in Niger, 2012