This repo is a template for a research project and companion site. The repo consists of four main areas:
-
the yaml file describes the basic layout of the site, which is a landing page with some tabs along the top of the page. Note that the yaml as currently written anticipates that you host the site as part of GitHub pages and that the site's html files are in the docs folder. The yaml also excludes the data subdirectory from compiling into the docs folder for the site.
-
The landing page is described in the index file.
-
The rest of the .Rmd files relate to each of the tabs listed in the yaml file. This template envisions four such tabs (data, analysis, appendix, and present).
-
The subdirectories (analysis, data, data-code, html, presentations, results) house other materials relevant for the repo, as described below:
- data: the raw data...should be added to your .gitignore file
- data-code: code files for data management (no analysis here)
- analysis: code files for analysis (anything that goes into the actual paper)
- results: output and potentially log files from the analysis, with subdirectories for figures and tables
- presentations: all files necessary to build different presentations of the paper
Recall, _site.yml tells Rstudio how to build the site - particularly, that the site should go into the "docs" folder. To deploy the companion site, follow these steps:
-
Enable github pages
-
Build site with the build site button or rmarkdown::render_site()
-
Push changes to github. Note, if you're using a custom site for github pages, then github creates a new "CNAME" file, which you'll need to pull. This gets deleted every time you recreate the docs folder, so just be careful not to push the deleted file to github!
The final rendered site is available here.
Ian McCarthy
Department of Economics • Emory University
Faculty Research Fellow • National Bureau of Economic Research
ianmccarthyecon.com • @ianhealthecon