Home

Awesome

brockdown

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.

Installation

To install and use beaverdown brockdown and use it for your dissertation/thesis, you will need:

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.

New R Markdown

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.

<!-- The current output for the four versions is here: - [PDF](https://github.com/ismayc/thesisdown_book/blob/gh-pages/thesis.pdf) (Generating LaTeX file is available [here](https://github.com/ismayc/thesisdown_book/blob/gh-pages/thesis.tex) with other files at in the [book directory](https://github.com/ismayc/thesisdown_book/tree/gh-pages).) - [Word](https://github.com/ismayc/thesisdown_book/blob/gh-pages/thesis.docx) - [ePub](https://github.com/ismayc/thesisdown_book/blob/gh-pages/thesis.epub) - [gitbook](http://ismayc.github.io/thesisdown_book) Under the hood, the Reed College LaTeX template (and soon the Reed College Word template) is used to ensure that documents conform precisely to submission standards. At the same time, composition and formatting can be done using lightweight [markdown](http://rmarkdown.rstudio.com/authoring_basics.html) syntax, and **R** code and its output can be seamlessly included using [rmarkdown](http://rmarkdown.rstudio.com). Using **thesisdown** has some prerequisites which are described below. To compile PDF documents using **R**, you are going to need to have LaTeX installed. It can be downloaded for Windows at <http://http://miktex.org/download> and for Mac at <http://tug.org/mactex/mactex-download.html>. Follow the instructions to install the necessary packages after downloading the (somewhat large) installer files. You may need to install a few extra LaTeX packages on your first attempt to knit as well. ### Using thesisdown from Chester's GitHub To use **thesisdown** from RStudio: 1) Install the latest [RStudio](http://www.rstudio.com/products/rstudio/download/). 2) Install the **thesisdown** package: ```S install.packages("devtools") devtools::install_github("ismayc/thesisdown") ``` 3) Use the **New R Markdown** dialog to select **Thesis**: ![New R Markdown](thesis_rmd.png) Note that this will currently only **Knit** if you name the directory `index` as shown above. -->