raw_data: Download Open Case Study Raw Data

Description Usage Arguments Details Value Examples

View source: R/raw_data.R

Description

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

Usage

1
raw_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.

Details

This function downloads the Open Case Study raw data from GitHub and saves it in a new 'OCS_data/data/raw/' folder in the specified directory. This makes it so all the raw data are easily available in a local folder to be processed and wrangled.

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)
raw_data('ocs-bp-opioid-rural-urban', outpath = tmp)

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