Package 'censable'

Title: Making Census Data More Usable
Description: Creates a common framework for organizing, naming, and gathering population, age, race, and ethnicity data from the Census Bureau. Accesses the API <https://www.census.gov/data/developers/data-sets.html>. Provides tools for adding information to existing data to line up with Census data.
Authors: Christopher T. Kenny [aut, cre]
Maintainer: Christopher T. Kenny <[email protected]>
License: MIT + file LICENSE
Version: 0.0.7
Built: 2024-10-27 02:48:12 UTC
Source: https://github.com/christopherkenny/censable

Help Index

Add Entry to Renviron

Description

Adds a value to the Renvironment of the form name=value. Designed for flexibly adding API keys for future sessions. Defaults are set up for entering a Census API key to work with tidycensus. By default this key will be configured to work with tidycensus. Package internally allows this key to work with censusapi when used through censable.

Usage

add_r_environ(
  value,
  name = "CENSUS_API_KEY",
  overwrite = FALSE,
  install = FALSE
)

Arguments

value

Character. Value to add.
name

Defaults to CENSUS_API_KEY. Character. Name to give value.
overwrite

Defaults to FALSE. Boolean. Should existing item with name name in Renviron be overwritten?
install

Defaults to FALSE. Boolean. Should this be added '~/.Renviron' file?

Value

value, invisibly

Examples

## Not run: 
add_r_environ('1234', 'SECRET_API_KEY')

## End(Not run)

Breakdown Census GEOID into Components

Description

Breakdown Census GEOID into Components

Usage

breakdown_geoid(.data, GEOID = "GEOID", area_type = "spine")

Arguments

.data

dataframe, tibble, or sf tibble
GEOID

Column in .data with Census GEOID
area_type

String, default is 'spine' with type of GEOID. Options are 'spine' for states, counties, tracts, block groups, and blocks. 'shd' for lower state legislative districts, 'ssd' for upper state legislative districts, 'cd' for congressional districts, or 'zcta' for zip code tabulation areas.

Value

.data with added identifying columns based on area_type

Examples

data(mt_county)
mt_county <- mt_county %>% breakdown_geoid()

Build Data from the American Community Survey

Description

Creates a dataset, using the decennial census information, with the standard variables used for redistricting. Creates a stable base for getting data from censusapi for common calls in redistricting.

#' # Output columns are:

  • GEOID: Geographic Identifier

  • NAME: Name of County

  • pop: total population

  • pop_white: total population, Non-Hispanic White

  • pop_black: total population, Non-Hispanic Black

  • pop_hisp: total population, Hispanic

  • pop_aian: total population, Non-Hispanic American Indian and Alaskan Native

  • pop_asian: total population, Non-Hispanic Asian

  • pop_nhpi: total population, Non-Hispanic Native Hawaiian and Pacific Islander

  • pop_other: total population, Non-Hispanic Other

  • pop_two: total population, Non-Hispanic Two Plus Races

  • vap: voting age population

  • vap_white: voting age population, Non-Hispanic White

  • vap_black: voting age population, Non-Hispanic Black

  • vap_hisp: voting age population, Hispanic

  • vap_aian: voting age population, Non-Hispanic American Indian and Alaskan Native

  • vap_asian: voting age population, Non-Hispanic Asian

  • vap_nhpi: voting age population, Non-Hispanic Native Hawaiian and Pacific Islander

  • vap_other: voting age population, Non-Hispanic Other

  • vap_two: voting age population, Non-Hispanic Two Plus Races

  • geometry: sf geometry

Arguments for geography are not checked, so will error if invalid. This is by design to avoid blocking usage that could become valid.

Currently valid options for geography:

  • 'state'

  • 'county'

  • 'tract'

  • 'block group'

  • 'block'

  • 'county subdivision'

  • 'zcta'

  • 'congressional district'

  • 'state legislative district (upper chamber)'

  • 'state legislative district (lower chamber)'

  • 'school district (unified)'

  • 'school district (elementary)'

  • 'school district (secondary)'

Usage

build_acs(
  geography,
  state = NULL,
  county = NULL,
  geometry = TRUE,
  year = 2020,
  survey = "acs5",
  groups = "all"
)

mem_build_acs(
  geography,
  state = NULL,
  county = NULL,
  geometry = TRUE,
  year = 2020,
  survey = "acs5",
  groups = "all"
)

Arguments

geography

Required. The geography level to use.
state

Required. Two letter state postal code.
county

Optional. Name of county. If not provided, returns blocks for the entire state.
geometry

Defaults to TRUE. Whether to return the geometry or not.
year

year, must be 2000, 2010, or 2020 (after August 2021)
survey

whether the get estimates from the 5-year ('acs5'), 3-year ('acs3'), or 1-year ('acs1') survey. Default is 'acs5'.
groups

defaults to 'all', which gets pop and vap. If 'pop', only gets pop. If 'vap', only gets vap. Any other strings default to 'all'.

Value

tibble with observations for each observation of the geography in the state or county. Data includes up to 3 sets of columns for each race or ethnicity category: population (pop), voting age population (vap), and citizen voting age population (cvap)

Examples

## Not run: 
# uses the Census API
tb <- build_acs(geography = 'tract', state = 'NY', county = 'Rockland', geometry = TRUE)

## End(Not run)

Build Data from the Decennial Census

Description

Creates a dataset, using the decennial census information, with the standard variables used for redistricting. Creates a stable base for getting data from censusapi for common calls in redistricting.

Usage

build_dec(
  geography,
  state = NULL,
  county = NULL,
  geometry = TRUE,
  year = 2020,
  groups = "all"
)

mem_build_dec(
  geography,
  state = NULL,
  county = NULL,
  geometry = TRUE,
  year = 2020,
  groups = "all"
)

Arguments

geography

Required. The geography level to use.
state

Required. Two letter state postal code.
county

Optional. Name of county. If not provided, returns blocks for the entire state.
geometry

Defaults to TRUE. Whether to return the geometry or not.
year

year, must be 2000, 2010, or 2020 (after August 2021)
groups

defaults to 'all', which gets pop and vap. If 'pop', only gets pop. If 'vap', only gets vap. Allows for analogous seven category race with 'all7', 'pop7', and 'vap7'. For counts for any part by race, you can supply ap:race, where race is in c('black', 'white', 'aian', 'other', 'asian', 'nhpi'). Anything that can't be matched defaults to 'all', so you can pass '' to get 'all'.

Value

tibble with observations for each observation of the geography in the state or county. Data includes up to 2 sets of columns for each race or ethnicity category: population (pop) and voting age population (vap)

Default output columns are:

  • GEOID: Geographic Identifier

  • NAME: Name of County

  • pop: total population

  • pop_white: total population, Non-Hispanic White

  • pop_black: total population, Non-Hispanic Black

  • pop_hisp: total population, Hispanic

  • pop_aian: total population, Non-Hispanic American Indian and Alaskan Native

  • pop_asian: total population, Non-Hispanic Asian

  • pop_nhpi: total population, Non-Hispanic Native Hawaiian and Pacific Islander

  • pop_other: total population, Non-Hispanic Other

  • pop_two: total population, Non-Hispanic Two Plus Races

  • vap: voting age population

  • vap_white: voting age population, Non-Hispanic White

  • vap_black: voting age population, Non-Hispanic Black

  • vap_hisp: voting age population, Hispanic

  • vap_aian: voting age population, Non-Hispanic American Indian and Alaskan Native

  • vap_asian: voting age population, Non-Hispanic Asian

  • vap_nhpi: voting age population, Non-Hispanic Native Hawaiian and Pacific Islander

  • vap_other: voting age population, Non-Hispanic Other

  • vap_two: voting age population, Non-Hispanic Two Plus Races

  • geometry: sf geometry

Arguments for geography are not checked, so will error if invalid. This is by design, to avoid blocking usage that could become valid.

Currently valid options for geography:

  • 'state'

  • 'county'

  • 'tract'

  • 'block group'

  • 'block'

  • 'county subdivision'

  • 'zcta'

  • 'congressional district'

  • 'state legislative district (upper chamber)'

  • 'state legislative district (lower chamber)'

  • 'school district (unified)'

  • 'school district (elementary)'

  • 'school district (secondary)'

  • 'voting district' may also work, though seems to be less reliable

Examples

## Not run: 
# uses the Census API
tb <- build_dec(geography = 'block', state = 'NY', county = 'Rockland', geometry = TRUE)

## End(Not run)

Collapse Full Race Categories into 4 Categories

Description

Collapses Other, AIAN, Asian, NHPI, and Two+ into other, by prefix.

Usage

collapse4(.data, prefix)

Arguments

.data

tibble, data.frame, or sf tibble
prefix

The prefix(es) for the race categories. Must be a character vector.

Value

.data with columns collapsed

Examples

data(mt_county)
mt_county <- mt_county %>% collapse4(prefix = c('pop_', 'vap_'))

Collapse Population Race Categories into 4 Categories

Description

Collapses Other, AIAN, Asian, NHPI, and Two+ into other.

Usage

collapse4_pop(.data, prefix = "pop_")

Arguments

.data

tibble, data.frame, or sf tibble
prefix

Default is pop_. The prefix for the race categories.

Value

.data with columns collapsed

Examples

data(mt_county)
mt_county <- mt_county %>% collapse4_pop()

Collapse Voting Age Population Race Categories into 4 Categories

Description

Collapses Other, AIAN, Asian, NHPI, and Two+ into other.

Usage

collapse4_vap(.data, prefix = "vap_")

Arguments

.data

tibble, data.frame, or sf tibble
prefix

Default is vap_. The prefix for the race categories.

Value

.data with columns collapsed

Examples

data(mt_county)
mt_county <- mt_county %>% collapse4_vap()

Collapse Full Race Categories into 5 Categories

Description

Collapses Other, AIAN, NHPI, and Two+ into Other, by prefix.

Usage

collapse5(.data, prefix)

Arguments

.data

tibble, data.frame, or sf tibble
prefix

The prefix(es) for the race categories. Must be a character vector.

Value

.data with columns collapsed

Examples

data(mt_county)
mt_county <- mt_county %>% collapse5(prefix = c('pop_', 'vap_'))

Collapse Population Race Categories into 5 Categories

Description

Collapses Other, AIAN, NHPI, and Two+ into other.

Usage

collapse5_pop(.data, prefix = "pop_")

Arguments

.data

tibble, data.frame, or sf tibble
prefix

Default is pop_. The prefix for the race categories.

Value

.data with columns collapsed

Examples

data(mt_county)
mt_county <- mt_county %>% collapse5_pop()

Collapse Voting Age Population Race Categories into 5 Categories

Description

Collapses Other, AIAN, NHPI, and Two+ into other.

Usage

collapse5_vap(.data, prefix = "vap_")

Arguments

.data

tibble, data.frame, or sf tibble
prefix

Default is vap_. The prefix for the race categories.

Value

.data with columns collapsed

Examples

data(mt_county)
mt_county <- mt_county %>% collapse5_vap()

Create GEOID from Default Columns

Description

Create GEOID from Default Columns

Usage

construct_geoid(
  .data,
  area_type,
  state = "state",
  county = "county",
  tract = "tract",
  block_group = "block group",
  block = "block",
  cd = "cd",
  shd = "shd",
  ssd = "ssd",
  zcta = "zcta"
)

Arguments

.data

dataframe, tibble, or sf tibble
area_type

Defaults to creating the smallest possible with 'spine' for states, counties, tracts, block groups, and blocks. You can also pass one of the on spine geographies to create that specific level. Other options are 'shd' for lower state legislative districts, 'ssd' for upper state legislative districts, 'cd' for congressional districts, or 'zcta' for zip code tabulation areas.
state

name of column with state component
county

name of column with county component
tract

name of column with tract component
block_group

name of column with block group component
block

name of column with block component
cd

name of column with cd component
shd

name of column with shd component
ssd

name of column with ssd component
zcta

name of column with zcta component

Value

.data with new column GEOID

Examples

data(mt_county)
mt_county <- mt_county %>% breakdown_geoid()
mt_county <- mt_county %>% dplyr::select(-dplyr::all_of('GEOID'))
mt_county <- mt_county %>% construct_geoid()

Create a GEOID from Columns

Description

Create a GEOID from Columns

Usage

custom_geoid(.data, ...)

Arguments

.data

dataframe, tibble, or sf tibble
...

columns of .data in the order you want to make the GEOID

Value

.data with new column GEOID

Examples

data(mt_county)
mt_county <- mt_county %>% custom_geoid(GEOID)

Counties FIPS 2000

Description

Contains three columns:

  • state: state FIPS

  • county: county FIPS

  • name: county name

Usage

data('fips_2000')

Value

tibble

Examples

data('fips_2000')

Counties FIPS 2010

Description

Contains three columns:

  • state: state FIPS

  • county: county FIPS

  • name: county name

Usage

data('fips_2010')

Value

tibble

Examples

data('fips_2010')

Counties FIPS 2020

Description

Contains three columns:

  • state: state FIPS

  • county: county FIPS

  • name: county name

Usage

data('fips_2020')

Value

tibble

Examples

data('fips_2020')

Join Abb by ANSI

Description

Adds a column with state abbreviation joining by a column with state ansi

Usage

join_abb_ansi(.data, .ansi)

Arguments

.data

data.frame or tibble
.ansi

column with state ansi

Value

.data with column .ansi replaced with state abbreviation

Examples

data('stata')
stata %>% join_abb_ansi(ansi)

Join Abb by FIPS

Description

Adds a column with state abbreviation joining by a column with state fips

Usage

join_abb_fips(.data, .fips)

Arguments

.data

data.frame or tibble
.fips

column with state fips

Value

.data with column .fips replaced with state abb

Examples

data('stata')
stata %>% join_abb_fips(fips)

Join Abb by Name

Description

Adds a column with state abbs joining by a column with state names

Usage

join_abb_name(.data, .name)

Arguments

.data

data.frame or tibble
.name

column with state name

Value

.data with column .name replaced with abbreviation

Examples

data('stata')
stata %>% join_abb_name(name)

Join ANSI by Abb

Description

Adds a column with state ansi joining by a column with state abbreviation

Usage

join_ansi_abb(.data, .abb)

Arguments

.data

data.frame or tibble
.abb

column with state abbreviation

Value

.data with column .abb replaced with state ansi

Examples

data('stata')
stata %>% join_ansi_abb(abb)

Join ANSI by FIPS

Description

Adds a column with state ansi joining by a column with state fips

Usage

join_ansi_fips(.data, .fips)

Arguments

.data

data.frame or tibble
.fips

column with state fips

Value

.data with column .fips replaced with state ansi

Examples

data('stata')
stata %>% join_ansi_fips(fips)

Join ANSI by Name

Description

Adds a column with state ansi joining by a column with state name

Usage

join_ansi_name(.data, .name)

Arguments

.data

data.frame or tibble
.name

column with state name

Value

.data with column .name replaced with ansi

Examples

data('stata')
stata %>% join_ansi_name(name)

Join FIPS by Abb

Description

Adds a column with state fips joining by a column with state abbreviation

Usage

join_fips_abb(.data, .abb)

Arguments

.data

data.frame or tibble
.abb

column with state abbreviation

Value

.data with column .abb replaced with state name

Examples

data('stata')
stata %>% join_fips_abb(abb)

Join FIPS by ANSI

Description

Adds a column with state fips joining by a column with state ansi

Usage

join_fips_ansi(.data, .ansi)

Arguments

.data

data.frame or tibble
.ansi

column with state ansi

Value

.data with column .ansi replaced with state fips

Examples

data('stata')
stata %>% join_fips_ansi(ansi)

Join FIPS by Name

Description

Adds a column with state fips joining by a column with state name

Usage

join_fips_name(.data, .name)

Arguments

.data

data.frame or tibble
.name

column with state name

Value

.data with column .name replaced with fips

Examples

data('stata')
stata %>% join_fips_name(name)

Join Name by Abb

Description

Adds a column with state name joining by a column with state abbreviation

Usage

join_name_abb(.data, .abb)

Arguments

.data

data.frame or tibble
.abb

column with state abbreviation

Value

.data with column .abb replaced with state name

Examples

data('stata')
stata %>% join_name_abb(abb)

Join Name by ANSI

Description

Adds a column with state name joining by a column with state ansi

Usage

join_name_ansi(.data, .ansi)

Arguments

.data

data.frame or tibble
.ansi

column with state ansi

Value

.data with column .ansi replaced with state name

Examples

data('stata')
stata %>% join_name_ansi(name)

Join Name by FIPS

Description

Adds a column with state name joining by a column with state fips

Usage

join_name_fips(.data, .fips)

Arguments

.data

data.frame or tibble
.fips

column with state fips

Value

.data with column .fips replaced with state name

Examples

data('stata')
stata %>% join_name_fips(fips)

Check or Get Census API Key

Description

Check or Get Census API Key

Usage

has_census_key()

get_census_key(key = "")

Arguments

key

Census API Key as a character

Value

logical if has, key if get

Examples

has_census_key()

Try to Match to State Abbreviation

Description

Searches for an exact match and offers the best match if no exact match

Usage

match_abb(state)

Arguments

state

character with state FIPS, Abbreviation, Name, or ANSI

Value

Abbreviation if a match is found or character(0) if no match is found

Examples

match_abb('NY')
match_abb('01')

Try to Match to State ANSI

Description

Searches for an exact match and offers the best match if no exact match

Usage

match_ansi(state)

Arguments

state

character with state FIPS, Abbreviation, Name, or ANSI

Value

ANSI if a match is found or character(0) if no match is found

Examples

match_ansi('NY')
match_ansi('01')

Try to Match to State FIPS

Description

Searches for an exact match and offers the best match if no exact match

Usage

match_fips(state)

Arguments

state

character with state FIPS, Abbreviation, Name, or ANSI

Value

FIPS code if a match is found or character(0) if no match is found

Examples

match_fips('NY')
match_fips('01')

Try to Match to State Name

Description

Searches for an exact match and offers the best match if no exact match

Usage

match_name(state)

Arguments

state

character with state FIPS, Abbreviation, Name, or ANSI

Value

Name if a match is found or character(0) if no match is found

Examples

match_name('NY')
match_name('01')

Montana County Data

Description

  • GEOID: Geographic Identifier

  • NAME: Name of County

  • pop: total population

  • pop_white: total population, Non-Hispanic White

  • pop_black: total population, Non-Hispanic Black

  • pop_hisp: total population, Hispanic

  • pop_aian: total population, Non-Hispanic American Indian and Alaskan Native

  • pop_asian: total population, Non-Hispanic Asian

  • pop_nhpi: total population, Non-Hispanic Native Hawaiian and Pacific Islander

  • pop_other: total population, Non-Hispanic Other

  • pop_two: total population, Non-Hispanic Two Plus Races

  • vap: voting age population

  • vap_white: voting age population, Non-Hispanic White

  • vap_black: voting age population, Non-Hispanic Black

  • vap_hisp: voting age population, Hispanic

  • vap_aian: voting age population, Non-Hispanic American Indian and Alaskan Native

  • vap_asian: voting age population, Non-Hispanic Asian

  • vap_nhpi: voting age population, Non-Hispanic Native Hawaiian and Pacific Islander

  • vap_other: voting age population, Non-Hispanic Other

  • vap_two: voting age population, Non-Hispanic Two Plus Races

  • geometry: sf geometry

Usage

data('mt_county')

Value

sf tibble with one observation for each county in Montana

Examples

data('mt_county')

Recode Abb by ANSI

Description

Replaces state ansi with state abbreviation

Usage

recode_abb_ansi(.data, .ansi)

Arguments

.data

data.frame or tibble
.ansi

column with state ansi

Value

.data with column .ansi replaced with state abbreviation

Examples

data('stata')
stata %>% recode_abb_ansi(ansi)

Recode Abb by FIPS

Description

Replaces state fips with state abb

Usage

recode_abb_fips(.data, .fips)

Arguments

.data

data.frame or tibble
.fips

column with state fips

Value

.data with column .fips replaced with state abb

Examples

data('stata')
stata %>% recode_abb_fips(fips)

Recode Abb by Name

Description

Replaces state name with state abbreviation

Usage

recode_abb_name(.data, .name)

Arguments

.data

data.frame or tibble
.name

column with state name

Value

.data with column .name replaced with abbreviation

Examples

data('stata')
stata %>% recode_abb_name(name)

Recode ANSI by Abb

Description

Replaces state abbreviation with state ansi

Usage

recode_ansi_abb(.data, .abb)

Arguments

.data

data.frame or tibble
.abb

column with state abbrevaition

Value

.data with column .abb replaced with state ansi

Examples

data('stata')
stata %>% recode_ansi_abb(abb)

Recode ANSI by FIPS

Description

Replaces state fips with state ansi

Usage

recode_ansi_fips(.data, .fips)

Arguments

.data

data.frame or tibble
.fips

column with state fips

Value

.data with column .fips replaced with state ansi

Examples

data('stata')
stata %>% recode_ansi_fips(fips)

Recode ANSI by Name

Description

Replaces state name with state ansi

Usage

recode_ansi_name(.data, .name)

Arguments

.data

data.frame or tibble
.name

column with state name

Value

.data with column .name replaced with ansi

Examples

data('stata')
stata %>% recode_ansi_name(name)

Recode FIPS by Abb

Description

Replaces state abbreviation with state fips

Usage

recode_fips_abb(.data, .abb)

Arguments

.data

data.frame or tibble
.abb

column with state abbrevaition

Value

.data with column .abb replaced with state name

Examples

data('stata')
stata %>% recode_fips_abb(abb)

Recode FIPS by ANSI

Description

Replaces state ansi with state fips

Usage

recode_fips_ansi(.data, .ansi)

Arguments

.data

data.frame or tibble
.ansi

column with state ansi

Value

.data with column .ansi replaced with state fips

Examples

data('stata')
stata %>% recode_fips_ansi(ansi)

Recode FIPS by Name

Description

Replaces state name with state fips

Usage

recode_fips_name(.data, .name)

Arguments

.data

data.frame or tibble
.name

column with state name

Value

.data with column .name replaced with fips

Examples

data('stata')
stata %>% recode_fips_name(name)

Recode Name by Abb

Description

Replaces state abbreviation with state name

Usage

recode_name_abb(.data, .abb)

Arguments

.data

data.frame or tibble
.abb

column with state abbrevaition

Value

.data with column .abb replaced with state name

Examples

data('stata')
stata %>% recode_name_abb(abb)

Recode Name by ANSI

Description

Replaces state ansi with state name

Usage

recode_name_ansi(.data, .ansi)

Arguments

.data

data.frame or tibble
.ansi

column with state ansi

Value

.data with column .ansi replaced with state name

Examples

data('stata')
stata %>% recode_name_ansi(name)

Recode Name by FIPS

Description

Replaces state fips with state name

Usage

recode_name_fips(.data, .fips)

Arguments

.data

data.frame or tibble
.fips

column with state fips

Value

.data with column .fips replaced with state name

Examples

data('stata')
stata %>% recode_name_fips(fips)

stata (State Data)

Description

tibble with columns:

  • fips: Federal Information Processing Standards codes

  • abb: two letter postal abbreviations

  • name: title case state name

  • ansi: American National Standards Institute codes

  • region: Census Regions (for 50 states and D.C.)

  • division: Census Divisions (for 50 states and D.C.)

Usage

data('stata')

Value

tibble with state identifying information

Examples

data('stata')