load_HealthCanada_Opioid_Table: Obtain the latest Opioid data from Health Canada

In OralOpioids: Retrieving Oral Opioid Information

Obtain the latest Opioid data from Health Canada

Description

load_HealthCanada_Opioid_Table compares the date of the local HealthCanada_Opioid_Table and compares it with the latest date of data provided Health Canada. In case the local file is outdated, an updated file will be generated.

Usage

load_HealthCanada_Opioid_Table(
  filelocation = "",
  no_download = FALSE,
  verbose = TRUE
)

Arguments

filelocation	String. The directory on your system where you want the dataset to be downloaded. If "", filelocation will be set to the download path within the OralOpioids package installation directory.
no_download	Logical. If set to TRUE, no downloads will be executed and no user input is required. Default: FALSE.
verbose	Logical. Indicates whether messages will be printed in the console. Default: TRUE.

Value

The function returns the HealthCanada_Opioid_Table as a data.frame. Comments on the data.frame include a status message (msg), the HealthCanada_Opioid_Table save path (path), a disclaimer, and the source for the retrieved data (source_url_data and source_url_dosing).

Examples

  HealthCanada_Opioid_Table <- load_HealthCanada_Opioid_Table(no_download = TRUE)
  head(HealthCanada_Opioid_Table)

OralOpioids documentation built on May 29, 2024, 8:54 a.m.