pumas: Download a Public Use Microdata Area (PUMA) shapefile into R

View source: R/pumas.R

pumasR Documentation

Download a Public Use Microdata Area (PUMA) shapefile into R

Description

Public use microdata areas (PUMAs) are decennial census areas that have been defined for the tabulation and dissemination of Public Use Microdata Sample (PUMS) data, American Community Survey (ACS) data, and ACS period estimates. For the 2010 Census, the State Data Centers (SDCs) in each state, the District of Columbia, and the Commonwealth of Puerto Rico were given the opportunity to delineate PUMAs within their state or statistically equivalent entity. All PUMAs must nest within states and have a minimum population threshold of 100,000 persons. 2010 PUMAs were built on census tracts and cover the entirety of the United States, Puerto Rico, Guam, and the U.S. Virgin Islands. Because they do not meet the minimum population requirement, the Commonwealth of the Northern Mariana Islands and American Samoa do not contain any 2010 PUMAs.

Usage

pumas(state = NULL, cb = FALSE, year = NULL, ...)

Arguments

state

The two-digit FIPS code (string) of the state you want. Can also be state name or state abbreviation. When NULL and combined with cb = TRUE, a national dataset of PUMAs will be returned when year is either 2019 or 2020.

cb

If cb is set to TRUE, download a generalized (1:500k) states file. Defaults to FALSE (the most detailed TIGER/Line file)

year

the data year; defaults to 2022

...

arguments to be passed to internal function load_tiger, which is not exported. See Additional Arguments.

Additional Arguments

Additional arguments that can be passed in ... are:

  • class Desired class of return object: "sf" (the default) or "sp". sp classes should be considered deprecated as of tigris version 2.0, but legacy support is still available.

  • progress_bar If set to FALSE, do not display download progress bar (helpful for R Markdown documents). Defaults to TRUE.

  • keep_zipped_shapefile If set to TRUE, do not delete zipped shapefile (stored in temporary directory or TIGRIS_CACHE_DIR depending on the configuration of global option "tigris_use_cache"). Defaults to FALSE.

  • refresh Whether to re-download cached shapefiles (TRUE or FALSE) . The default is either FALSE or the value of global option "tigris_refresh" if it is set. Specifying this argument will override the behavior set in "tigris_refresh" global option.

  • filter_by Geometry used to filter the output returned by the function. Can be an sf object, an object of class bbox, or a length-4 vector of format c(xmin, ymin, xmax, ymax) that can be converted to a bbox. Geometries that intersect the input to filter_by will be returned.

See Also

https://www.census.gov/programs-surveys/geography/guidance/geo-areas/pumas.html

Other general area functions: block_groups(), blocks(), counties(), county_subdivisions(), places(), school_districts(), states(), tracts(), zctas()

Examples

## Not run: 
library(tigris)

us_states <- unique(fips_codes$state)[1:51]

continental_states <- us_states[!us_states %in% c("AK", "HI")]
pumas_list <- lapply(continental_states, function(x) {
  pumas(state = x, cb = TRUE, year = 2017)
  })

us_pumas <- rbind_tigris(pumas_list)

plot(us_pumas$geometry)

## End(Not run)

tigris documentation built on May 29, 2024, 2:20 a.m.