Skip to content

Latest commit

 

History

History
executable file
·
143 lines (77 loc) · 5.93 KB

README.md

File metadata and controls

executable file
·
143 lines (77 loc) · 5.93 KB

Welcome!

Lifecycle: stable thanks-md license

This is a minimal Thesis template based on R Markdown, bookdown and thesisdown. This template originally designed to work with the Monash University Thesis guidelines. Currently this template is functional in knitting gitbook and PDF version.

The monashthesis.tex and monashthesis.cls are collected from Prof' Rob J Hyndman's github repository and modified to the updated guidlines. If you dont want the monash logo commentout 188 number line in [\includegraphics[width=15cm]{figures/monash-logo}] monashthesis.cls.

In this template, copyright, abstract, declaration, acknowledgement, and preface come before table of content as advised by the latest template guideline.

Current Functional Output

  • PDF

  • epub

  • gitbook

How to use

Make you sure you have rmakrdown, bookdown and thesisdown packages installed. You also need to have have a LaTex installed. tinytex can help you in that regards

install.packages(c('tinytex', 'rmarkdown'))
tinytex::install_tinytex()
# after restarting RStudio, confirm that you have LaTeX with
tinytex:::is_tinytex()


To use monashthesisdown with your R studio:

  1. Make sure you have LaTeX and the latest version of RStudio.

  2. Install bookdown, monashthesisdown and thesisdown packages

    if (!require("remotes")) 
      install.packages("remotes", repos = "https://cran.rstudio.org")
    remotes::install_github("rstudio/bookdown")
    remotes::install_github("ismayc/thesisdown")
    remotes::install_github("masiraji/monashthesisdown")
    
    

After installing these restart your Rstudio.

3. In Rstudio you can get started with monashthesisdown by clicking File > New Project > New Directory and selecting Thesis project using monashthesisdown

Next, give your project a name and specify where you'd like the files to appear. In the screenshot below, the project name is my_thesis and it will appear as a new folder on my Desktop.

Day-to-day writing of your thesis

Each chapter of your thesis should be in different .Rmd files. If you want specific LaTeX packages to add, put them in monashthesis.tex. This template provides a skeleton file structure that you can edit to create your thesis. Edit the **_bookdown.yml** file to set the order in which you'd like them to appear. It's recommended that you version control your thesis using GitHub if possible. see this link to know more about github based version controlling in Rstudio.

Rendering

This package use render_book command from bookdown package to render PDF and gitbook version of your thesis in accordance with the guidline of Monash University. Any change that you want to bring in can be done by modifying monashthesis.cls file.

bookdown::render_book("index.Rmd", "bookdown::gitbook")
bookdown::render_book("index.Rmd", "bookdown::pdf_book")

Changing the position of Table of Content

Toc after the title page

  • In this template, table of content comes after preface. If you want your table of content just after the title page remove the following latex commands from the 00-preface.Rmd file.

\newpage

\setstretch{1.2}\sf\tighttoc\doublespacing

\newpage

\listoftables

\newpage

\listoffigures

  • And you also need to activate lines number 34-36 in monasthesis.tex containing the following latex command

{\setstretch{1.2}\sf\tighttoc\doublespacing}

\listoftables

\listoffigures

Placing the Toc wherever you wish

  • You can place your Toc wherever you want by removing the the following command lines from 00-preface.Rmd and placing them in the respective Rmd files:

    \newpage

    \setstretch{1.2}\sf\tighttoc\doublespacing

    \newpage

    \listoftables

    \newpage

    \listoffigures

Components

The following components are ones you should edit to customize your thesis:

_bookdown.yml

Edit the **_bookdown.yml** file to set the order in which you'd like the Rmd files to appear.

index.Rmd

This file contains all the meta information that goes at the beginning of your document. You'll need to edit the top portion of this file (the YAML) to put your name on the first page, the title of your thesis, etc. Note that you need to have at least one chapter start in the index.Rmd file for the build to work.

00-abstact.Rmd01-chap1.Rmd, etc.

These are the Rmd files for each chapter in your dissertation. Write your thesis in these. If you're writing in RStudio, you may find the wordcount addin useful for getting word counts and readability statistics in R Markdown documents.

bib/

Store your bibliography (as bibtex files) here. We recommend using the citr addin and Zotero to efficiently manage and insert citations.

csl/

Specific style files for bibliographies should be stored here. A good source for citation styles ishttps://github.com/citation-style-language/styles#readme.

figure/ and data/

Store your figures and data here and reference them in your R Markdown files. See the bookdown book for details on cross-referencing items using R Markdown.