Skip to contents

Functions

age_to_age_group()
Convert an Integer Age to an Age Group
calculate_age_range_from_gap()
Calculate an Age Range from an Age-Gap Specification
calculate_z_squared_score()
Calculate a Z-Squared Goodness-of-Fit Statistic
calculate_fractions()
Calculate Conditional Fractions from a Contingency Table
calculate_group_counts()
Convert Fractions into Integer Agent Counts
create_household_with_id()
Create a Household Record and Assign a Household Identifier
get_margin_frames_from_synthetic_population()
Generate Multiple Margin Tables from a Synthetic Population
get_margin_series_from_synthetic_population()
Extract a Margin Distribution from a Synthetic Population
group_children()
Group Children into Sibling Sets
make_agents()
Create Synthetic Agents From Aggregate Counts
multicolumn_to_attribute_values()
Convert Multiple Columns to Attribute Combinations
parse_age_gap()
Parse an Age-Gap Specification
pair_partners()
Create Couples from Eligible Adults
plot_validation_differences()
Plot percentage-point differences
plot_validation_distributions()
Plot observed and expected distributions
plot_validation_heatmap()
Plot validation heatmap
prepare_contingency_table()
Prepare a Contingency Table for Attribute Assignment
synthetic_population_to_contingency()
Convert a Synthetic Population to a Contingency Table
validate_synthetic_population_fit()
Validate the Fit of a Synthetic Population

S4 Classes

ReplicaAdder()
Create a ReplicaAdder Module
ReplicaAdder-class
Replica Attribute Assignment Module
ReplicaGrouper()
Create a ReplicaGrouper Object
ReplicaGrouper-class
ReplicaGrouper Class
ReplicaStructure()
Create a ReplicaStructure Object
ReplicaStructure-class
ReplicaStructure Class

Methods

renew(<ReplicaAdder>) renew(<ReplicaGrouper>) renew(<ReplicaStructure>)
Renew replica modules
agentToHousehold()
Assign Household Identifiers to Agents
createFromMembers()
Create Households from Household Members
enhance(<ReplicaAdder>) enhance(<ReplicaGrouper>)
Enhance Replica Modules
getPositionForName()
Retrieve a Household Position Definition
householdsToDataFrame()
Convert Synthetic Households to a Data Frame
updateState()
Update ReplicaStructure State
ratify(<ReplicaAdder>)
Ratify Attribute Assignment Results