nhgisfips: Assemble FIPS Code from State, County, Tract, Blockgroup...

View source: R/nhgisfips.R

nhgisfipsR Documentation

Assemble FIPS Code from State, County, Tract, Blockgroup Portions

Description

Helper function for reading demographic data files downloaded from NHGIS.org

Usage

nhgisfips(
  x,
  validfields = c("STATEA", "COUNTYA", "TRACTA", "BLKGRPA"),
  fullname = c("FIPS.ST", "FIPS.COUNTY", "FIPS.TRACT", "FIPS.BG"),
  leadz = c(2, 3, 6, 1)
)

Arguments

x

Data.frame or matrix with appropriate colnames, containing portions of FIPS code in separate columns.

validfields

Optional, default is colnames used in datasets downloaded from NHGIS.org as of 8/2015 for ACS data. Defaults: c("STATEA", "COUNTYA", "TRACTA", "BLKGRPA")

fullname

Optional, default is based on default for validfields parameter: c("FIPS.ST", "FIPS.COUNTY", "FIPS.TRACT", "FIPS.BG"). Specifies colname for the output, which depends on how many cols of fips portions are in x.

leadz

Optional, default is based on default for validfields parameter: c(2, 3, 6, 1) Defines total number of characters in correctly formatted portions of FIPS, such as 2 for State FIPS (e.g., "01").

Details

This can also be used more generically in other contexts, by specifying appropriate parameters.

Value

A 1-column data.frame with same number of rows as x. Provides assembled FIPS for each row.

See Also

nhgis(), nhgisread(), ejanalysis::clean.fips()

Examples

## Not run: 
x <- structure(list(STATEA = structure(c(2L, 3L, 1L),
.Label = c("10", "8", "9"), class = "factor"),
COUNTYA = structure(1:3, .Label = c("1", "10", "100"), class = "factor"),
TRACTA = structure(c(2L, 1L, 2L), .Label = c("000006", "123456"), class = "factor"),
BLKGRPA = c("1", "2", "3"), data = c(0, 0, 0)),
.Names = c("STATEA", "COUNTYA", "TRACTA", "BLKGRPA", "data"),
row.names = c(NA, -3L), class = "data.frame")
x
nhgisfips(x[ , 1, drop=FALSE])
nhgisfips(x[ , 1:2], fullname=c('stfips', 'countyfips', 'tractfips', 'bgfips'))
nhgisfips(x[ , 1:3])
nhgisfips(x[ , 1:4])
nhgisfips(x)

## End(Not run)

ejanalysis/ACSdownload documentation built on Jan. 18, 2025, 7:43 a.m.