extra_data {OCSdata} | R Documentation |
Download Open Case Study Extra Data
Description
Download the specified case study extra data to use as you wish.
Usage
extra_data(casestudy, outpath = NULL)
Arguments
casestudy |
character string, name of the case study to pull data from. The input name should follow the same naming scheme as the repository on GitHub: ocs-bp-opioid-rural-urban ocs-bp-RTC-wrangling ocs-bp-co2-emissions |
outpath |
character string, path to the directory where the downloaded data folder should be saved to. |
Details
This function downloads the Open Case Study extra data from GitHub and saves it in a new 'OCS_data/data/extra/' folder in the specified directory. This makes it so all the extra data are easily available in a local folder for your use.
Value
If download is successful, the path to the downloaded data folder is printed and the logical value TRUE is returned. Otherwise the appropriate error message is printed.
Examples
tmp = tempfile()
dir.create(tmp)
extra_data('ocs-bp-opioid-rural-urban', outpath = tmp)