censusapi (version 0.3.0)

getCensus: Retrieve Census data from a given API

Description

Retrieve Census data from a given API

Usage

getCensus(name, vintage = NULL, key = Sys.getenv("CENSUS_KEY"), vars,
  region, regionin = NULL, time = NULL, date = NULL, period = NULL,
  monthly = NULL, category_code = NULL, data_type_code = NULL)

Arguments

name

API name - e.g. acs5. See list at https://api.census.gov/data.html

vintage

Year of dataset, e.g. 2014 - not required for timeseries APIs

key

Your Census API key, gotten from https://api.census.gov/data/key_signup.html

vars

List of variables to get

region

Geography to get

regionin

Optional hierarchical geography to limit region

time

Optional argument used for some time series APIs

date

Optional argument used for some time series APIs

period

Optional argument used for some time series APIs

monthly

Optional argument used for some time series APIs

category_code

Argument used in Economic Indicators Time Series API

data_type_code

Argument used in Economic Indicators Time Series API

Examples

# NOT RUN {
df <- getCensus(name = "acs/acs5", vintage = 2016,
	vars = c("B01001_001E", "NAME", "B01002_001E", "B19013_001E"),
	region = "tract:*", regionin = "state:06")
head(df)

# Use American Community Survey variable groups to get all data from a given table.
# This returns estimates as well as margins of error and annotation flags.
acs_group <- getCensus(name = "acs/acs5", vintage = 2016,
	vars = c("NAME", "group(B19013)"),
	region = "county:*")
	head(acs_group)

# Retreive block-level data within a specific state and county using a nested regionin argument
data2010 <- getCensus(name = "sf1", vintage = 2010,
vars = c("P0010001", "P0030001"),
region = "block:*", regionin = "state:36+county:27")
head(data2010)

# Retreive block-level data for Decennial Census sf1, 2000
# Note, for this dataset a tract needs to be specified to retrieve blocks
data2000 <- getCensus(name = "sf1", vintage = 2000,
	vars = c("P001001", "P003001"),
region = "block:*", regionin = "state:36+county:27+tract:010000")
head(data2000)

# Get time series data
saipe <- getCensus(name = "timeseries/poverty/saipe",
	vars = c("NAME", "SAEPOVRT0_17_PT", "SAEPOVRTALL_PT"),
	region = "state:*", time = 2011)
head(saipe)
# }
# NOT RUN {
# }