/manusdown

An updated R Markdown thesis template using the bookdown package

Primary LanguageTeXMIT LicenseMIT

manusdown

This project was based off of thesisdown. The template is based on the MIT LaTeX template and the Reed College LaTeX template. As noted on the MIT Thesis page, you should always consult the MIT Libraries Thesis Specifications before submitting your thesis. Because I used this for writing my own thesis, while this template adheres to the MIT Thesis template, it is rather hacked together quickly, and there is much room for improvement. If you have suggestions/would like to push your changes, please get in touch! My email (for the time being) is yangjy [ at ] mit

Currently, the PDF and gitbook versions are fully-functional. The word and epub versions are developmental, have no templates behind them, and are essentially calls to the appropriate functions in bookdown.

If you are new to working with bookdown/rmarkdown, please read over the documentation available in the gitbook template at https://thesisdown.netlify.com/. This is also available below at https://ismayc.github.io/thesisdown_book.

As an example, a copy of my thesis is currently available at ratatstats/thesis, the pdf is available here.

The current output for three of the four versions is here:

Under the hood, the Reed College LaTeX 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 syntax, and R code and its output can be seamlessly included using rmarkdown.

Customizing thesisdown to your institution

Please see Chester Ismay's thesisdown repo (https://github.com/ismayc/thesisdown) for more information.

Using manusdown

Using manusdown 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 https://miktex.org/download and for Mac at https://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.

To use manusdown from RStudio:

  1. Install the latest RStudio. Only the version as of Oct 2017 has a recent enough Pandoc included so you may need to upgrade this separately or install a newer RStudio.

    rmarkdown::pandoc_available("1.2")
    #> [1] TRUE
  2. Install the bookdown and manusdown packages:

install.packages("remotes")
remotes::install_github("rstudio/bookdown")
remotes::install_github("ratatstats/manusdown")
  1. Use the New R Markdown dialog to select Thesis:

    New R Markdown

    Note that this will currently only Knit if you name the directory index as shown above.

  2. After choosing which type of output you'd like in the YAML at the top of index.Rmd, Knit the index.Rmd file to get the book in PDF or HTML formats.

  3. Edit the individual chapter R Markdown files as you wish and then re-run step (4) again.