count_household_income_by_race: Return the householder count per income bracket and per race...

In johardi/commondata-r: A Collection of Common Data

Description

Return the householder count per income bracket and per race group for the given the geographical names (i.e., zip codes, state codes, state names, county names) and the observation year period.

Usage

count_household_income_by_race(
  geo_names,
  location_type = c(NA, "zip", "county", "state"),
  start_year = 2011,
  end_year = 2018,
  year = NA
)

Arguments

geo_names	required, vector of string(s) of geographical names.
location_type	optional, string indicating the location type of the geographical names. NA by default.
start_year	optional, integer indicating the start year of observation. 2011 by default.
end_year	optional, integer indicating the end year of observation. 2018 by default.
year	optional, integer indicating a single year of observation. This parameter overrides the start_year and end_year parameters when it is not NA, such that start_year=year and end_year=year. NA by default.

Value

A named list with each list item is a data frame containing the household income observations of each region per income bracket. The data frame is identified by the observation year and race group.

Examples

zips <- c("94035","94039","94040","94041","94042","94043")

# Count the householders per income and race group in the specified ZIP codes
count_household_income_by_race(zips)

# Count the householders from 2012 to 2015
count_household_income_by_race(zips, start_year=2012, end_year=2015)

# Count the householders in 2012
count_household_income_by_race(zips, year=2012)

# Count the householders in the state of California
count_household_income_by_race(c("California")) # State name
count_household_income_by_race(c("CA")) # State code
count_household_income_by_race(c("06")) # 2-digit state FIPS code

johardi/commondata-r documentation built on July 7, 2021, 11:24 p.m.