count_recall_by_years {caRecall}

Count of recalls searching by year

Description

Returns the count of recalls in the Vehicle Recalls Database based on a year range search term.

Usage

count_recall_by_years(start_year = 1900, end_year = 2100, api_key = NULL)

Arguments

start_year

Start of year range (optional).

end_year

End of year range (optional).

api_key

API access key to use, if not set in environment.

Details

Queries the Vehicle Recalls Database API by year range and returns the count of recalls in the database. If start_year and/or end_year are not specified, the function will default to the start and/or end years available in the database. Note that the year range is based on the manufactured year and not the year a recall occurred.

An API key is required to run the function and query the Vehicle Recalls Database. The key can be acquired at https://tc.api.canada.ca/en/detail?api=VRDB.

The API key can be set in the environment using Sys.setenv(VRD_API = 'your_API_key_here') and will be used by the function, or can be passed into the function using the api_key argument.

Value

A tibble providing the count of recalls from the Vehicle Recalls.

Examples

## Not run: 
count_recall_by_years(2010, 2012)
API_KEY <- "xxxxxxxxxxx"
count_recall_by_years(end_year = 1970, api_key = API_KEY)

## End(Not run)