count_person_by_sex: Return the person count per age group and per sex category...

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

Description

Return the person count per age group and per sex category for the given the geographical names (i.e., zip codes, state codes, state names, county names, or school district) and the observation year period.

Usage

count_person_by_sex(
  geo_names,
  location_type = c(NA, "zip", "county", "state", "school"),
  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 person count of each region per age group. The data frame is identified by the observation year and the sex category.

Examples

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

# Count the population in the specified ZIP codes
count_person_by_sex(zips)

# Count the population from 2012 to 2015
count_person_by_sex(zips, start_year=2012, end_year=2015)

# Count the population in 2012
count_person_by_sex(zips, year=2012)

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

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