caRecall (version 0.1.0)

recall_by_number: Summary of recalls searching by recall number(s)

Description

Returns summary information of recalls in the Vehicle Recalls Database based on recall numbers(s).

Usage

recall_by_number(recall_number, limit = 25, api_key = NULL)

Arguments

recall_number

List of recall numbers.

limit

Number indicating how many recall entries should be returned. Defaults to 25 which is the default of the API.

api_key

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

Value

A tibble of recall summary information from the Vehicle Recalls Database. Includes six columns.

Details

Queries the Vehicle Recalls Database API by recall number and returns summary recall information.

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.

Examples

# NOT RUN {
recall_by_number(1977044)
API_KEY <- "xxxxxxxxxxx"
recall_by_number(c(2014216, 2013022), api_key = API_KEY)
# }