get_arrest_count: Get arrest data from the UCR's Arrests by Age, Sex, and Race...

Description Usage Arguments Value Examples

View source: R/ucr_arrest.R

Description

Get arrest data from the UCR's Arrests by Age, Sex, and Race data set.

Usage

1
2
3
4
5
6
7
get_arrest_count(
  ori = NULL,
  state_abb = NULL,
  region = NULL,
  monthly = FALSE,
  key = get_api_key()
)

Arguments

ori

A string or vector of strings of the 9-character ORI code (unique agency ID) for the desired agency.

state_abb

String or vector of strings input for state abbreviation(s) to get data for. If NULL (default) returns national data. If 'state_abb' and 'region' both have values, will use return 'region' input data.

region

String or vector of strings input for region name(s) to get data for. Please run 'list_regions()' to see all possible variables.

monthly

If TRUE (not default), returns data as monthly units. Otherwise returns annual data.

key

A string containing your FBI's Crime Data Explorer API key

Value

A data.frame with the number of arrests for each crime-year in the jurisdiction.

Examples

1
2
3
4
5
## Not run: 
get_arrest_count(ori = "CA0010900")
get_arrest_count()

## End(Not run)

jacobkap/fbiAPI documentation built on Sept. 17, 2020, 3:16 a.m.