-
Notifications
You must be signed in to change notification settings - Fork 8
/
README.Rmd
178 lines (139 loc) · 8.88 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
---
output: github_document
---
# iheiddown
<img src="man/figures/iheiddown.png" align="right" width="220"/>
```{r setup, include=FALSE}
# Sources the render_toc() function from Garrick Aden Buie
# Note: Headers must be definded with hashtags for correct parsing
knitr::opts_chunk$set(echo = TRUE)
devtools::source_gist("c83e078bf8c81b035e32c3fc0cf04ee8",
filename = 'render_toc.R')
```
<!-- badges: start -->
[](https://lifecycle.r-lib.org/articles/stages.html#maturing)
<!-- [](http://hits.dwyl.com/jhollway/iheiddown) -->
[](https://app.codecov.io/gh/jhollway/iheiddown?branch=main)
[](https://www.codefactor.io/repository/github/jhollway/iheiddown/overview/main)
<!--  -->
<!-- badges: end -->
## Table of Contents
```{r toc, echo=FALSE}
render_toc("README.Rmd", base_level = 1, toc_depth = 2)
```
`{iheiddown}` is a package that provides templates for writing documents
in styles consistent with the Geneva Graduate Institute/
Institut de Hautes Etudes Internationales et du Developpement (IHEID)
in (R) markdown.
The main use case for `{iheiddown}` is for writing
a **Masters or PhD Dissertation at IHEID**,
as it offers a user-friendly, simple, and straightforward way
to write a well-formatted and consistent dissertation
that weaves together argument, evidence, and interpretation. However, it also
integrates templates for creating IHEID themed presentations powered by
[`{xaringan}`](https://github.com/yihui/xaringan) as well as a template for
IHEID course syllabi.
## Write your dissertation
The package is built upon the [IHEID LaTeX dissertation template](https://github.com/jhollway/iheidmytex),
which offers versus common word processors:
- less prone to corruption or crashing
- more internal consistency
- ensured consistency with the IHEID dissertation and other guidelines, e.g. dedication, abstract, abbreviations,
tables of contents, figures, and tables
- automatic figure and table referencing
- automatic compilation of your references and bibliography (under different styles)
- compilation chapter-by-chapter (for sending to your supervisor) or whole dissertation (for submission)
- cross-referencing
- smaller files
- automatic versioning
- and much more!
Though you may have never had problems using Word in the past,
the size and structure of most theses tax Word's capabilities.
However, `{iheiddown}` helps you avoid the need to (learn how to) write in LaTeX.
LaTeX can be daunting for first time users,
and many users often feel it would only pay off if they were writing very complex dissertations.
`{iheiddown}` allows students to write their dissertations in _RMarkdown_.
[_Markdown_](https://www.markdownguide.org) is a simple and easy-to-use way to 'markup' parts of plain text as headings, **bold** or *italics*
(and much more) in ways that remain very readable and thus editable as you write.
`{iheiddown}`, R, and LaTeX do the work to turn this into a beautiful dissertation.
You write in minimally marked-up plain text and you get a correctly-formatted dissertation out at the end.
But wait, there's more!
Because `{iheiddown}` is an **R** package,
it especially shines for those who are analysing data.
[R](https://www.r-project.org) is a *free* statistical programme and language
that has a *huge* range of packages available for most current methods of analysis and visualisation.
[RStudio](https://posit.co/) is a typical frontend that makes working in **R**
and especially with `{iheiddown}` easy.
So though `{iheiddown}` is especially attractive to those writing dissertations with many tables and figures,
the user-friendly nature and pretty output should make it of great benefit to nearly anyone writing a thesis project.
You can see an example of the kind of dissertation output on the package website.
## But not only !
Not quite done yet, there is even more! Take a look at the following table for
all available templates:
| Templates | Format | Status |
| ---------------- | ---------------------------- | ------------------ |
| Thesis | PDF | :thumbsup: |
| Syllabus | PDF | :thumbsup: |
| [`{xaringan}`](https://github.com/yihui/xaringan) presentations | HTML (can be printed to PDF) | :thumbsup: |
| Problem set | PDF | :thumbsup: |
| Posters | HTML (+ print to PDF) | :star2: :new: :star2: |
| *Your idea* | *Open a PR!* | :sparkles: |
## Installation
### Prerequisites
You will first need to install the following software on your system<sup>[2](#myfootnote2)</sup>:
- [R](https://cran.r-project.org)
- [RStudio version 1.2 or higher](https://posit.co/download/rstudio-desktop/#download), and
- [LaTeX](https://www.latex-project.org/get/) or [MiKTeX](https://miktex.org/howto/install-miktex/)<sup>[1](#myfootnote1)</sup>
### Installing the Stable Version
The easiest way to install the latest stable version of `{iheiddown}` is via CRAN.
Simply open the R console and enter the following to install and load
`{iheiddown}`
```{r, eval=FALSE}
install.packages('iheiddown')
library(iheiddown)
```
That's it! `iheiddown` is now installed and ready to go.
### Installing the Development Version
To get access to the latest features, you may want to install the development
version of the package.
An easy way of getting access to this version is to install the
latest main version of `{iheiddown}` from Github.
To do that, please install the `{remotes}` package from CRAN and then enter the
following commands into the console:
- For latest stable version: `remotes::install_github("jhollway/iheiddown")`
- For latest development version: `remotes::install_github("jhollway/iheiddown@develop")`
Alternatively, you can find the binaries for all major OSes -- Windows, Mac, and Linux --
by looking up the latest release of the package [here](https://github.com/jhollway/iheiddown/releases/latest).
Manually download the appropriate binary for your operating system,
and install using an adapted version of the following commands:
- For Windows: `install.packages("~/Downloads/iheiddown_winOS.zip", repos = NULL)`
- For Mac: `install.packages("~/Downloads/iheiddown_macOS.tgz", repos = NULL)`
- For Unix: `install.packages("~/Downloads/iheiddown_linuxOS.tar.gz", repos = NULL)`
## Quick start guide
`{iheiddown}`, among other things, sets up a thesis template that you can
then modify for your dissertation. It's very easy to get started!
Since the process is similar for theses, presentations, problem sets and syllabi
let us take a look at how to set up a thesis project.
1. Open RStudio (if it is not already).
1. Click the new document symbol at the very top left and choose `R Markdown...`.
1. Then from the options on the left `From Template`.
1. Scroll down through the options on the right until you find `Thesis {iheiddown}`.
1. Name your thesis project `index`, i.e. your main `.Rmd` should be named `index.Rmd`
1. Select where the project should be saved on your hard drive.
Congratulations! You have now set up your first thesis project. For a more
detailed walkthrough of the different functionalities and how to get started
with each one, please check out the different articles on the
[package website](https://jhollway.github.io/iheiddown/).
## Feedback
Please [raise an issue](https://github.com/jhollway/iheiddown/issues) for this repo
if you encounter any bugs or if you have any feature requests.
You can also vote on existing issues that you would like to see addressed soon.
If you would like to contribute to the repo,
please fork this repository and open a pull request when your changes are ready,
or [get in touch with me](https://jameshollway.com) directly.
<sup><a name="myfootnote1">1</a></sup> For Windows users, make sure you have the latest MiKTeX version installed on you computer. From the MiKTeX console, you should regularly check for updates as "MiKTeX user mode", this will prevent issues when generating your pdf document from your Markdown template.
<sup><a name="myfootnote2">2</a></sup> Note that, for unclear reasons, Yihui Xie's [TinyTeX](https://yihui.org/tinytex/) is causing trouble. Try `tinytex::uninstall_tinytex()` and install a local copy. Unfortunately, full LaTeX installations are *large*.