R/data.R

In arilamstein/choroplethrCaCensusTract: Shapefile, Metadata and Visualization Functions for US Census Tracts in California

#' Map of US Census Tracts in California
#' 
#' The map comes from the 2010 Cartographic Boundary Shapefiles - Census Tracts 
#' from the US Census Bureau website.
#' A column named "region" was added which is a duplicate of the column GEOID. 
#' The GEOID is the concatenation of the 5-character county FIPS code and the 
#' 6-character TRACTCE column.
#' A column named "county.fips.numeric" was added which is the numeric version
#' of the county FIPS code of the tract.
#'  
#' @seealso \link{ca.tract.regions}
#' @docType data
#' @name ca.tract.map
#' @usage data(ca.tract.map)
#' @references Taken from \url{https://www.census.gov/geo/maps-data/data/cbf/cbf_tracts.html}.
NULL

#' Metadata about the California Census Tracts map
#' 
#' In addition to the region/GEOID it contains the TRACTCE and county FIPS code
#' as both an integer and character (i.e. with and without the leading "0")
#' 
#' @seealso \link{ca.tract.map}
#'  
#' @docType data
#' @name ca.tract.regions
#' @usage data(ca.tract.regions)
NULL

#'  A data.frame containing population estimates for California Census Tracts in 2012. 
#' 
#' @references Taken from the US American Community Survey (ACS) 5 year estimates.
#' @seealso \link{df_ca_tract_demographics}
#'  
#' @docType data
#' @name df_pop_ca_tract
#' @usage data(df_pop_ca_tract)
#' @examples
#' data(df_pop_ca_tract)
#'
#' # zoom in on San Francisco, which has FIPS code 6075
#' ca_tract_choropleth(df_pop_ca_tract, 
#'                     title  = "2012 San Francisco Census Tract\n Population Estimates", 
#'                     legend = "Population",
#'                     county_zoom = 6075)
#' \dontrun{
#' ca_tract_choropleth(df_pop_ca_tract, 
#'                     title  = "2012 California Census Tract\n Population Estimates", 
#'                     legend = "Population")
#' 
#' }
NULL

#' A data.frame containing demographic statistics for each Census Tract in California.
#'       
#' @name df_ca_tract_demographics
#' @docType data
#' @references Data comes from the 2013 5-year American Community Survey (ACS). Data generated by
#' ?get_ca_tract_demographics. 
#' @keywords data
#' @usage data(df_ca_tract_demographics)
#' @examples
#'  # 2013 per capita income estimate
#'  data(df_ca_tract_demographics)
#'  colnames(df_ca_tract_demographics)
#'  
#'  df_ca_tract_demographics$value = df_ca_tract_demographics$per_capita
#'  ca_tract_choropleth(df_ca_tract_demographics,
#'                      title       = "2013 San Francisco Census Tract\n Per Capita Income",
#'                      legend      = "Income",
#'                      num_colors  = 1,
#'                      county_zoom = 6075)
NULL