Skip to content

Commit

Permalink
Added motivation and bumped version
Browse files Browse the repository at this point in the history
  • Loading branch information
jhollway committed Jun 18, 2020
1 parent f4322ac commit d9b3c98
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 4 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: iheiddown
Title: A RMarkdown class for IHEID dissertations
Version: 0.1.0
Version: 0.1.1
Authors@R:
c(person(given = "James",
family = "Hollway",
Expand All @@ -12,7 +12,7 @@ Description: This package supports writing theses according to
the Graduate Institute of International and Development Studies
regulations.
License: MIT + file LICENSE
Imports: bookdown, tidyverse
Imports: bookdown, tidyverse, roxygen2
Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
Expand Down
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,26 @@
![GitHub All Releases](https://img.shields.io/github/downloads/jhollway/iheiddown/total)
<!-- badges: end -->

This GitHub repository provides an R Markdown template for writing a Masters or PhD Dissertation at the Graduate Institute of International and Development Studies in Geneva based on the [IHEID LaTeX dissertation template](https://github.com/jhollway/iheidmytex) and R.
This GitHub repository provides an R Markdown template for writing
a Masters or PhD Dissertation at the Graduate Institute of International and Development Studies in Geneva
in RStudio based on the [IHEID LaTeX dissertation template](https://github.com/jhollway/iheidmytex).

_R Markdown_ creates a user-friendly, simple and straightforward way to write a well-formatted dissertation,
with nicely formatted paragraphs, tables and figures that can be generated directly from your data,
weaving together argument, evidence, and interpretation.
The use of LaTeX in combination with _Markdown_ is more consistent than the output of a word processor,
much less prone to corruption or crashing, and the resulting file is smaller than a Word file.
While you may have never had problems using Word in the past,
your thesis is likely going to be about twice as large and complex as anything you've written before,
taxing Word's capabilities.
Though `iheiddown` should shine in particular for those who are analysing data,
or are including tables, figures, equations, or complex cross-references
(e.g. table of contents, figures, tables, appendices, or an index) in their dissertation,
the user-friendly nature and pretty output should make it of great benefit to nearly anyone writing a thesis project.

## Installing iheiddown

1. Install [R](https://cran.rstudio.com), [RStudio version 1.2 or higher](https://www.rstudio.com/products/rstudio/download/#download), and [$\LaTeX$](https://www.latex-project.org/get/) on your system.<sup>[1](#myfootnote1)</sup>
1. Install [R](https://cran.rstudio.com), [RStudio version 1.2 or higher](https://www.rstudio.com/products/rstudio/download/#download), and [LaTeX](https://www.latex-project.org/get/) on your system.<sup>[1](#myfootnote1)</sup>
1. Open RStudio and click on the `Packages` tab of the bottom right pane of the window (by default).
Click `Install` at the top left of that tab and type "devtools" into the text box. Hit enter.
1. Next type (or copy) `devtools::install_github("jhollway/iheiddown")` into the prompt in the `Console` tab in the bottom left pane. Hit enter.
Expand Down

0 comments on commit d9b3c98

Please sign in to comment.