get_nibrs_victim: Gets victim-level data from the FBI's National Incident-Based...

In jacobkap/fbi: R Wrapper for the FBI's Crime Data API

Description

Gets victim-level data from the FBI's National Incident-Based Reporting System (NIBRS)

Usage

get_nibrs_victim(
  key = get_api_key(),
  offense = "robbery",
  variable = "race",
  ori = NULL,
  region = NULL,
  state_abb = NULL
)

Arguments

key	A string containing your FBI's Crime Data Explorer API key
offense	A string or vector of strings with the offenses you want to scrape. If input is 'all' (default), returns data for all offenses. Please run 'list_nibrs_offenses()' to see all possible offenses.
variable	A string with the variable you want the data to be in. This is essentially the units you want returned (number of victims by age, race, sex, etc.). By default returns total count of victims. Please run 'list_nibrs_victim_variables()' to see all possible variables.
ori	A string or vector of strings of the 9-character ORI code (unique agency ID) for the desired agency.
region	String or vector of strings input for region name(s) to get data for. Please run 'list_regions()' to see all possible variables.
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.

Value

A data.frame of NIBRS victim data.

See Also

Other NIBRS functions: get_nibrs_offender(), get_nibrs_offense(), list_nibrs_offender_variables(), list_nibrs_offense_variables(), list_nibrs_offenses(), list_nibrs_victim_variables(), list_regions(), list_ucr_arrest_offenses()

Examples

## Not run: 
get_nibrs_victim(ori = "DE0010100")

## End(Not run)

jacobkap/fbi documentation built on Sept. 18, 2020, 7:32 p.m.