Returns summary information of recalls in the Vehicle Recalls Database based on a make or manufacturer search term.
recall_by_make( make, manufacturer = FALSE, start_year = NULL, end_year = NULL, limit = 25, partial = TRUE, api_key = NULL )
make | List of make or manufacturer names. Case insensitive. |
---|---|
manufacturer | Logical; if TRUE, manufacturer is searched on instead of make. |
start_year | Start of year range (optional). |
end_year | End of year range (optional). |
limit | Number indicating how many recall entries should be returned. Defaults to 25 which is the default of the API. |
partial | Logical; if TRUE, returns all partial search term matches. |
api_key | API access key to use, if not set in environment. |
A tibble of recall summary information from the Vehicle Recalls Database. Includes six columns.
Queries the Vehicle Recalls Database API by make or manufacturer and returns
summary recall information. The year range of the search can be specified
and is based on the manufactured year and not the year a recall occurred.
Partial search term matches can also be returned by the function and is the
default. Note that if partial = FALSE
is used, the number of entries
returned by the function may be less than the count provided by
count_recall_by_make
which returns a count for all partial
matches.
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.
if (FALSE) { recall_by_make("Nissan") recall_by_make(c("Mazda", "Toyota"), start_year = 2008, partial = FALSE) API_KEY <- "xxxxxxxxxxx" recall_by_make("Maz", end_year = 2000, limit = 100, api_key = API_KEY) }