imported_data: Download Open Case Study Imported Data

Description Usage Arguments Details Value Examples

View source: R/imported_data.R

Description

Download the specified case study imported data to use as you follow along the case study.

Usage

1
imported_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-rural-and-urban-obesity

ocs-bp-air-pollution

ocs-bp-vaping-case-study

ocs-bp-opioid-rural-urban

ocs-bp-RTC-wrangling

ocs-bp-RTC-analysis

ocs-bp-youth-disconnection

ocs-bp-youth-mental-health

ocs-bp-school-shootings-dashboard

ocs-bp-co2-emissions

ocs-bp-diet

outpath

character string, path to the directory where the downloaded data folder should be saved to.

Details

This function downloads the Open Case Study imported data from GitHub and saves it in a new 'OCSdata/data/imported/' folder in the specified directory. This makes it so all the imported data are easily available in a local folder.

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

1
2
3
tmp = tempfile()
dir.create(tmp)
imported_data('ocs-bp-opioid-rural-urban', outpath = tmp)

OCSdata documentation built on Aug. 20, 2021, 9:07 a.m.