Package: synthACS 1.7.1

Alex Whitworth

synthACS: Synthetic Microdata and Spatial MicroSimulation Modeling for ACS Data

Provides access to curated American Community Survey (ACS) base tables via a wrapper to library(acs). Builds synthetic micro-datasets at any user-specified geographic level with ten default attributes; and, conducts spatial microsimulation modeling (SMSM) via simulated annealing. SMSM is conducted in parallel by default. Lastly, we provide functionality for data-extensibility of micro-datasets <doi:10.18637/jss.v104.i07>.

Authors:Alex Whitworth [aut, cre]

synthACS_1.7.1.tar.gz
synthACS_1.7.1.zip(r-4.5)synthACS_1.7.1.zip(r-4.4)synthACS_1.7.1.zip(r-4.3)
synthACS_1.7.1.tgz(r-4.5-x86_64)synthACS_1.7.1.tgz(r-4.5-arm64)synthACS_1.7.1.tgz(r-4.4-x86_64)synthACS_1.7.1.tgz(r-4.4-arm64)synthACS_1.7.1.tgz(r-4.3-x86_64)synthACS_1.7.1.tgz(r-4.3-arm64)
synthACS_1.7.1.tar.gz(r-4.5-noble)synthACS_1.7.1.tar.gz(r-4.4-noble)
synthACS_1.7.1.tgz(r-4.4-emscripten)synthACS_1.7.1.tgz(r-4.3-emscripten)
synthACS.pdf |synthACS.html✨
synthACS/json (API)

# Install 'synthACS' in R:
install.packages('synthACS', repos = c('https://cranhaven.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/cranhaven/cranhaven.r-universe.dev/issues

Uses libs:
  • c++– GNU Standard C++ Library v3
Datasets:
  • AgeRaceDR - Death rates in the United States by age and race, 2013
  • BR2014 - Birth Rates by Age and Race of Mother
  • LifeExp - Life expectancy at certain ages; United States, 2013
  • MBR - Multiple Birth Rate data by year and race of mother
  • TFR - Total Fertility Rate by race of mother
  • adjDR - Age-adjusted Death Rate by race and gender
  • la_hospitals - Hospitals in Los Angeles County, CA USA
  • rawDR - Raw Death Rate by race and gender
  • stateFR - Birth rates, by age of mother: United States, each state and territory, 2014

On CRAN:

archivedpackagesr-universecpp

3.89 score 5 stars 78 scripts 485 downloads 47 exports 23 dependencies

Last updated 8 days agofrom:2816371443 (on package/synthACS). Checks:1 ERROR, 10 OK. Indexed: no.

TargetResultLatest binary
Doc / VignettesFAILFeb 14 2025
R-4.5-win-x86_64OKFeb 14 2025
R-4.5-mac-x86_64OKFeb 14 2025
R-4.5-mac-aarch64OKFeb 14 2025
R-4.5-linux-x86_64OKFeb 14 2025
R-4.4-win-x86_64OKFeb 14 2025
R-4.4-mac-x86_64OKFeb 14 2025
R-4.4-mac-aarch64OKFeb 14 2025
R-4.3-win-x86_64OKFeb 14 2025
R-4.3-mac-x86_64OKFeb 14 2025
R-4.3-mac-aarch64OKFeb 14 2025

Exports:add_constraintall_geog_constraint_ageall_geog_constraint_eduall_geog_constraint_employmentall_geog_constraint_genderall_geog_constraint_geog_moball_geog_constraint_incomeall_geog_constraint_marital_statusall_geog_constraint_nativityall_geog_constraint_povertyall_geog_constraint_raceall_geog_optimize_microdataall_geog_synthetic_new_attributeall_geogs_add_constraintcalculate_TAEcombine_smsmderive_synth_datasetsfetch_datagen_attr_vectorsget_best_fitget_dataset_namesget_endyearget_final_taeget_geographyget_spanis.macro_microis.macroACSis.micro_syntheticis.smsm_setis.synthACSmarginalize_attroptimize_microdataplot_TAEpathpull_acs_basetablespull_bachelorspull_edupull_geo_mobilitypull_householdpull_inc_earningspull_mar_statuspull_populationpull_pov_incpull_race_datapull_synth_datapull_transit_worksplitsynthetic_new_attribute

Dependencies:acsaskpassclicurldata.tablegluehttrjsonlitelaterlifecyclemagrittrmimeopensslplyrR6RcppretryrlangstringistringrsysvctrsXML

split and combine_smsm

Rendered fromsplit_combine.Rmdusingknitr::rmarkdownon Feb 14 2025.

Last update: 2025-02-12
Started: 2025-02-12

synthACS: An Introduction

Rendered fromjss_synthACS.ltxusingR.rsp::texon Feb 14 2025.

Last update: 2025-02-12
Started: 2025-02-12

Readme and manuals

Help Manual

Help pageTopics
Add new constraint to constraint tableadd_constraint
Age-adjusted Death Rate by race and genderadjDR
Death rates in the United States by age and race, 2013AgeRaceDR
Create age constraint list to a set of geographiesall_geog_constraint_age
Create educational attainment constraint list to a set of geographiesall_geog_constraint_edu
Create employment status constraint list to a set of geographiesall_geog_constraint_employment
Create gender constraint list to a set of geographiesall_geog_constraint_gender
Create geographic mobility constraint list to a set of geographiesall_geog_constraint_geog_mob
Create individual income constraint list to a set of geographiesall_geog_constraint_income
Create marital status constraint list to a set of geographiesall_geog_constraint_marital_status
Create nativity status constraint list to a set of geographiesall_geog_constraint_nativity
Create poverty status constraint list to a set of geographiesall_geog_constraint_poverty
Create race constraint list to a set of geographiesall_geog_constraint_race
Optimize the selection of a micro data population for a set of geographies.all_geog_optimize_microdata
Add a new attribute to a set (ie list) of synthetic_micro datasetsall_geog_synthetic_new_attribute
Add new constraint to a set of geographiesall_geogs_add_constraint
Birth Rates by Age and Race of MotherBR2014
Calculate the total absolute error (TAE) between sample data and constraints.calculate_TAE
Combine separate SMSM optimizationscombine_smsm
Derive synthetic micro datasets for a given geography.derive_synth_datasets
Get Aggregate Data Specified Geographyfetch_data
Generate attribute vectorsgen_attr_vectors
Extract best fit for a specified geogrpahy from an 'smsm_set' objectget_best_fit
Get dataset names from a "macroACS" object.get_dataset_names
Get the endyear from a "macroACS" object.get_endyear
Extract the final TAE for a specified geogrpahy from an 'smsm_set' objectget_final_tae
Get the geography title from a "macroACS" object.get_geography
Get the span from a "macroACS" object.get_span
Check macro_micro classis.macro_micro
Check macroACS classis.macroACS
Check micro_synthetic classis.micro_synthetic
Check smsm_set classis.smsm_set
Check synthACS classis.synthACS
Hospitals in Los Angeles County, CA USAla_hospitals
Life expectancy at certain ages; United States, 2013LifeExp
Marginalize synthetic attributesmarginalize_attr
Multiple Birth Rate data by year and race of motherMBR
Optimize the selection of a micro data population.optimize_microdata
Plot simulated annealing pathplot_TAEpath
Pull ACS base tablespull_acs_basetables
Pull ACS data on field of bachelor's degreepull_bachelors
Pull ACS educational attainment and enrollment datapull_edu
Pull ACS geographic mobility datapull_geo_mobility
Pull ACS data on households and housing unitspull_household
Pull ACS income and earnings datapull_inc_earnings
Pull ACS marital status datapull_mar_status
Pull ACS population datapull_population
Pull ACS income and earnings datapull_pov_inc
Pull ACS race datapull_race_data
Pull ACS data for synthetic data creation.pull_synth_data
Pull ACS transit and work datapull_transit_work
Raw Death Rate by race and genderrawDR
Split a "macroACS" objectsplit
Birth rates, by age of mother: United States, each state and territory, 2014stateFR
Summarizing SMSM fitssummary.smsm_set
Add a new attribute to a synthetic_micro datasetsynthetic_new_attribute
Total Fertility Rate by race of motherTFR