# Synthetic Microdata and Spatial MicroSimulation Modeling for ACS Data

## Documentation for package ‘synthACS’ version 1.7.1

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

add_constraint | Add new constraint to constraint table
adjDR | Age-adjusted Death Rate by race and gender
AgeRaceDR | Death rates in the United States by age and race, 2013
all_geogs_add_constraint | Add new constraint to a set of geographies
all_geog_constraint_age | Create age constraint list to a set of geographies
all_geog_constraint_edu | Create educational attainment constraint list to a set of geographies
all_geog_constraint_employment | Create employment status constraint list to a set of geographies
all_geog_constraint_gender | Create gender constraint list to a set of geographies
all_geog_constraint_geog_mob | Create geographic mobility constraint list to a set of geographies
all_geog_constraint_income | Create individual income constraint list to a set of geographies
all_geog_constraint_marital_status | Create marital status constraint list to a set of geographies
all_geog_constraint_nativity | Create nativity status constraint list to a set of geographies
all_geog_constraint_poverty | Create poverty status constraint list to a set of geographies
all_geog_constraint_race | Create race constraint list to a set of geographies
all_geog_optimize_microdata | Optimize the selection of a micro data population for a set of geographies.
all_geog_synthetic_new_attribute | Add a new attribute to a set (ie list) of synthetic_micro datasets
BR2014 | Birth Rates by Age and Race of Mother
calculate_TAE | Calculate the total absolute error (TAE) between sample data and constraints.
combine_smsm | Combine separate SMSM optimizations
derive_synth_datasets | Derive synthetic micro datasets for a given geography.
fetch_data | Get Aggregate Data Specified Geography
gen_attr_vectors | Generate attribute vectors
get_best_fit | Extract best fit for a specified geogrpahy from an 'smsm_set' object
get_dataset_names | Get dataset names from a "macroACS" object.
get_endyear | Get the endyear from a "macroACS" object.
get_final_tae | Extract the final TAE for a specified geogrpahy from an 'smsm_set' object
get_geography | Get the geography title from a "macroACS" object.
get_span | Get the span from a "macroACS" object.
is.macroACS | Check macroACS class
is.macro_micro | Check macro_micro class
is.micro_synthetic | Check micro_synthetic class
is.smsm_set | Check smsm_set class
is.synthACS | Check synthACS class
la_hospitals | Hospitals in Los Angeles County, CA USA
LifeExp | Life expectancy at certain ages; United States, 2013
marginalize_attr | Marginalize synthetic attributes
MBR | Multiple Birth Rate data by year and race of mother
optimize_microdata | Optimize the selection of a micro data population.
plot_TAEpath | Plot simulated annealing path
pull_acs_basetables | Pull ACS base tables
pull_bachelors | Pull ACS data on field of bachelor's degree
pull_edu | Pull ACS educational attainment and enrollment data
pull_geo_mobility | Pull ACS geographic mobility data
pull_household | Pull ACS data on households and housing units
pull_inc_earnings | Pull ACS income and earnings data
pull_mar_status | Pull ACS marital status data
pull_population | Pull ACS population data
pull_pov_inc | Pull ACS income and earnings data
pull_race_data | Pull ACS race data
pull_synth_data | Pull ACS data for synthetic data creation.
pull_transit_work | Pull ACS transit and work data
rawDR | Raw Death Rate by race and gender
split | Split a "macroACS" object
stateFR | Birth rates, by age of mother: United States, each state and territory, 2014
summary.smsm_set | Summarizing SMSM fits
synthetic_new_attribute | Add a new attribute to a synthetic_micro dataset
TFR | Total Fertility Rate by race of mother