get_locations: Get a list of local vaccination locations

In chris31415926535/covaxr: Interface with Ontario's Provincial COVID-19 Vaccination Booking System

Description

This function returns a data frame with the names, locations, and identifiers of the COVID-19 vaccination locations that are available for a given vaccine dose, place, and date.

Usage

get_locations(
  lat,
  lng,
  fromDate = NA,
  doseNumber,
  vaccineData,
  search_radius = 25
)

Arguments

lat	Latitude of the location to search from.
lng	Longitude of the location to search from.
fromDate	Date to begin looking, in format YYYY-MM-DD.
doseNumber	Vaccine dose, either 1 or 2.
vaccineData	Personal API identifier.
search_radius	Range in km to search for locations.

Details

This function requires a personal API identifier, called vaccineData, that the Ontario covax API uses to grant access to the system. You can get your id by logging into the provincial booking system using Chrome and opening the developer console by pressing Ctrl-Shift-J (on a Windows machine–consult Google for advice on other machines)

• https://vaccine.covaxonbooking.ca/

Value

A tibble with the name, address, locations, and identifiers of all COVID-19 vaccination clinics matching the input criteria. In addition the returned object has class covax that includes metadata about the request– including the private API access key–that is used by other package functions.

Examples

## Not run: 
vax_data <- "YOUR_ONLINE_API_IDENTIFIER"
apts <- covaxr::get_locations(lat = 43.692556,
                              lng =  -79.377056,
                              fromDate = as.character(Sys.Date()),
                              doseNumber = 1,
                              vaccineData = vax_data) %>%
        covaxr::check_locations_covax(end_date = "2021-09-01")

## End(Not run)

chris31415926535/covaxr documentation built on Jan. 2, 2022, 1:24 a.m.