call_api_once: Call Census API for a set of variables

Description Usage Arguments Value

View source: R/call_census_api.R

Description

This is an internal function and is not intended for users. See instead call_census_api.

Usage

1
2
call_api_once(variables_to_get, geoid, allgeos, data_source, year, period,
  api_key)

Arguments

variables_to_get

A character vector of the desired variable names for the Census API call, defined at https://www.census.gov/data/developers/data-sets.html

geoid

A character string with a FIPS code, between 2 and 15 digits long.

allgeos

(optional) A string identifying the type of geography for which to collect data within the the requested geoids. Must be one of c('co', 'tr', 'bg', 'bl'). For instance, if allgeos = "bg", will return all block groups within the given geoids.

data_source

A string identifying whether the SF1 (decennial census) or ACS data is desired.

year

If data_source = "acs", the final year of the summary period. Default is 2013.

period

If data_source = "acs", the length of aggregation period. Default is 5, or a 5-year aggregation table.

api_key

The user's Census API key (as a character string). You can get a free key from [Census](http://api.census.gov/data/key_signup.html). See vignette('censusr', package = 'censusr') to setup a default key as an environment variable.

Value

A codedata.frame with the requested variables at the requested geography.


gregmacfarlane/censusr documentation built on Jan. 28, 2018, 10:35 a.m.