This is a project that has been adapted from Zhian Kamvar's beaverdown package. Below is the README document that was provided with the beaverdown package with slight alterations to ensure user's of brockdown can easily construct a thesis with compliant formatting specific to Brock University.
This project is a modified version Chester Ismay's thesisdown package to provide support for Oregon State University's thesis.
Currently, the PDF version is fully functional. All other versions are derived from thesisdown and are not guaranteed to work.
To install and use beaverdownbrockdown and use it for your dissertation/thesis, you will need:
- pandoc >= 2.0
- LaTeX
- R >= 3.3.0
- RStudio (optional, but it helps)
Open Rstudio and type:
if (!require("devtools")) install.packages("devtools", repos = "http://cran.rstudio.org")
devtools::install_github("brentthorne/brockdown")To use it, open Rstudio, click on File > New File > Rmarkdown ... and then select the Brock University Thesis from the Templates.
Note from brockdown: While this next step is good feel free to name the new RMarkdown document 'index' so that you do not have to make changes to other files down the line.
Make sure to give your thesis a title and save it to the correct path. Rstudio
will send you to that directory and then you should open _bookdown.yml and
edit the first Rmd file to be the name of your project:
book_filename: "thesis"
chapter_name: "Chapter "
-rmd_files: ["index.Rmd",
+rmd_files: ["myThesis.Rmd",
"chapters/01-chap1.Rmd",
"chapters/02-chap2.Rmd",
"chapters/03-chap3.Rmd",
"chapters/04-conclusion.Rmd",
"chapters/99-references.Rmd"
]Instructions for editing are in the README file.