README.md
In mca91/itewrpkg: A metapackage for Introduction to Econometrics with R

📦itewrpkg

A metapackage for the bookdown project Introduction to Econometrics with R, an interactive R companion to the textbook Introduction to Econometrics by Stock & Watson (2015).

The book can be found here.

The bookdown project is available in this GitHub repository.

It is straightforward to download and install the itewrpkg package from GitHub using install_github() from the devtools package. Run install.packages("devtools") if you are not sure whether devtools is installed.

The following one-liner installs itewrpkg:

# install `itewrpkg`
devtools::install_github("mca91/itewrpkg")

Running the above command will also install all R packages which are required for reproducing the code examples presented throughout the book. Running library(itewrpkg) will load the package and all dependencies which makes it unnecessary to individually attach the packages introduced at the beginning of each chapter. This may take a few seconds but may be convenient if you are playing around with code chunks from various chapters.

The function get_materials_itewr() is intented as a convenience function for students working with the companion. It downloads up-to-date versions of all supplements to the book such as datasets and R codes from the GitHub repository and saves them to the current working directory of R (or a location of choice provided to the argument dir) according to the following structure:

<your_working_directory>/ITEWR/Rmds/ (.Rmd files)
<your_working_directory>/ITEWR/Data/ (datasets)
<your_working_directory>/ITEWR/Rcodes/ (R scripts, numbered by chapter)

Make sure to check your working directory using getwd().

Upon attaching the package using library(itewrpkg) the following functions are available:

get_materials_itewr() downloads all the materials neccessary to reproduce R examples from the book (see above)
get_repo() downloads an entire GitHub repository
get_repo_filenames() scrapes file names from a GitHub repository
get_repo_files() gets all files from a specific folder in a GitHub repository
squeeze_rmds is a simple wrapper for knitr::purl() which tangles R code from chapters in a bookdown projekt to .R files