diff --git a/R/crosswalk_data.R b/R/crosswalk_data.R index 4cebef1..7f3e0e2 100644 --- a/R/crosswalk_data.R +++ b/R/crosswalk_data.R @@ -7,6 +7,14 @@ #' to a target geography. Can either accept a pre-fetched crosswalk from #' `get_crosswalk()` or fetch the crosswalk automatically using the provided #' geography and year parameters. +#' +#' A dedicated interpolation function is available vie `urbnindicators::interpolate_acs()` +#' for the special case where American Community Survey estimates are to be crosswalked; that +#' function correctly adjusts margins of error per Census Bureau guidance. Install the +#' package via `renv::install("UI-Research/urbnindicators")`. If you have error measurements +#' associated with non-ACS data, use caution --- `crosswalk_data()` will treat MOEs akin to any +#' other numeric column by default. Custom function(s) supplied to the `custom_interpolations` +#' parameter may be appropriate for non-ACS error measurements. #' #' @param data A data frame or tibble containing the data to crosswalk. #' @param crosswalk The output from `get_crosswalk()` - a list containing: diff --git a/man/crosswalk-package.Rd b/man/crosswalk-package.Rd index 4bc3cdc..e320bea 100644 --- a/man/crosswalk-package.Rd +++ b/man/crosswalk-package.Rd @@ -4,9 +4,9 @@ \name{crosswalk-package} \alias{crosswalk} \alias{crosswalk-package} -\title{crosswalk: Streamlined Inter-Temporal and Inter-Geography Crosswalking of Census Data} +\title{crosswalk: Translate Data across Space and Time} \description{ -Provides a standardized interface for accessing and applying geographic crosswalks between United States Census geographies, both across geographies (e.g., tracts to ZIP Code Tabulation Areas) and across time (e.g., 2010 tracts to 2020 tracts). Crosswalks are sourced from the Missouri Census Data Center's Geocorr applications, IPUMS NHGIS, the CT Data Collaborative, and a curated registry of county boundary changes drawn from Census Bureau documentation, and are returned with consistent column names and rich metadata. Also interpolates count and non-count variables from source to target geographies, with diagnostics describing join quality. +Provides a standardized interface for accessing and applying geographic crosswalks between United States Census geographies, both across geographies (e.g., tracts to ZIP Code Tabulation Areas) and across time (e.g., 2010 tracts to 2020 tracts). Also supports interpolating crosswalked data, with built-in diagnostics describing join quality. } \details{ The package standardizes access to geographic crosswalks from four sources: diff --git a/man/crosswalk_data.Rd b/man/crosswalk_data.Rd index dc409ae..944fe35 100644 --- a/man/crosswalk_data.Rd +++ b/man/crosswalk_data.Rd @@ -53,7 +53,9 @@ crosswalk is being fetched, uses same-year crosswalk via Geocorr.} One of c("population", "housing", "land"). Default is "population".} \item{cache}{Directory path or NULL. Where to cache fetched crosswalks. If NULL -(default), crosswalk is fetched but not saved to disk.} +(default), crosswalk is fetched but not saved to disk. The directory must +already exist; a non-existent path raises an error rather than being +created silently.} \item{geoid_column}{Character. The name of the column in \code{data} containing the source geography identifiers (GEOIDs). Default is "source_geoid".} @@ -131,6 +133,14 @@ to a target geography. Can either accept a pre-fetched crosswalk from geography and year parameters. } \details{ +A dedicated interpolation function is available vie \code{urbnindicators::interpolate_acs()} +for the special case where American Community Survey estimates are to be crosswalked; that +function correctly adjusts margins of error per Census Bureau guidance. Install the +package via \code{renv::install("UI-Research/urbnindicators")}. If you have error measurements +associated with non-ACS data, use caution --- \code{crosswalk_data()} will treat MOEs akin to any +other numeric column by default. Custom function(s) supplied to the \code{custom_interpolations} +parameter may be appropriate for non-ACS error measurements. + \strong{Two usage patterns}: \enumerate{ \item \strong{Pre-fetched crosswalk}: Pass the output of \code{get_crosswalk()} to the