-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.Rmd
170 lines (122 loc) · 5.45 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
---
output:
bookdown::github_document2:
html_preview: false
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%",
tidy = "styler"
)
```
# jladown
<!-- badges: start -->
<!-- badges: end -->
## Background
While the [*Journal of Learning Analytics (JLA)*](https://epress.lib.uts.edu.au/journals/index.php/JLA/index)
provides a [Word document](https://drive.google.com/uc?export=download&id=1ST6Fr9w1xgpRK_2Xuhczhrxw98RFqYOI) and
[LaTeX](https://drive.google.com/uc?export=download&id=1LMkbm-HKAWliyTyRpzn1o0OxduJuVw7f)
template, these can be challenging to use for a number of reasons,
including the technical requirements of using a LaTeX template for the first
time and the challenge of editing a document in Word that is serving as a
template.
Moreover, the imperative of producing reproducible analyses extends to writing
manuscripts (see [van der Zee and Reich, 2018](https://journals.sagepub.com/doi/full/10.1177/2332858418787466)),
and yet reproducibility is a serious challenge during this step, in part due to
a lack of available tools.
The goal of jladown is to provide a reproducible template for the *Journal of
Learning Analytics* using R Markdown in multiple formats - particularly pdf -
but also gitbook (for viewing via a web browser), and Word. This package allows
for both text and R code to be written in a single document and to be rendered
into a format that can be easily submitted to *JLA*.
## Installation
`jladown` is currently under development on GitHub. Please install and test the
package as follows:
```{r installation, eval = FALSE}
if(!require(remotes)) {
install.packages("remotes")
}
remotes::install_github('jooyoungseo/jladown')
```
While not required for installation (as other LaTeX installations will likely
also suffice), we recommend the use of the [{tinytex}](https://yihui.org/tinytex/)
R package and associated LaTeX installation.
## Example
This is a basic example which shows you how to use `jladown` package. While
other formats are usable, `pdf` output is fully supported at this moment.
### Loading the package
```{r, eval = FALSE}
library(jladown)
```
### For RStudio users
For RStudio users, as long as `jladown` is installed, we recommend to create a
new project which contains the file used for the contents of the manuscript (in
`index.Rmd`, described more below) and other files used to render the file.
1. From within RStudio, select
"File" ->
"New Project" ->
"New Directory" and then select the *Journal of Learning Analytics*
(`jladown`) template.
2. Next, give your new directory a name, such as `my-jla-manuscript`.
3. Then, edit the `index.Rmd` document, which should automatically be open, but
which can always be opened by selecting the file from its location in the
"Files" pane of RStudio. More instructions on editing the `index.Rmd` file are
provided in the "Using the template (index.Rmd)" section.
### For non-RStudio users
For non-RStudio users (or those looking to use the command line),
you may create a project template in the current path with the following
function:
```{r, eval = FALSE}
jladown:::jladown_skeleton('.')
```
Then, edit the `index.Rmd` file. More instructions on editing the `index.Rmd`
file are provided in the "Using the template (index.Rmd)" section.
## Editing the template (`index.Rmd`)
To use the template, open (if not already opened) and edit the `index.Rmd` file.
We provide a brief overview of using the template here;
see the template for more specific details.
### Front matter
First, edit the following key fields in the front-matter (which is
in the [YAML format](https://yaml.org/):
- Title
- Author
- Affiliation
- Keywords
- Abstract
<!-- I'm not sure that the next line is true, and so I commented it out for now: -->
<!-- We note that fields that are not edited will not be included in the rendered -->
<!-- document. -->
### Body
Edit the body as you would any document. The `#` symbol represents a header;
additional `#` symbols represent different levels of headers, as follows:
- `#`: Level-1 header
- `##`: Level-2 header
- `###`: Level-3 header
- `####`: Level-4 header
Text can be italicized using the `*` symbol, as with the following text:
*emphasized statement*.
Code can be included with
[R Markdown code chunks](https://rmarkdown.rstudio.com/lesson-3.html);
images not generated from code in these chunks can be included in a chunk via
the function `knitr::include_graphics()`.
### References
References can be included in [BibTeX format]
(http://www.bibtex.org/) using [the apacite format]
(http://ctan.uniminuto.edu/biblio/bibtex/contrib/apacite/apacite.pdf)
## Rendering a PDF (or gitbook or Word) document from the template
Render the template to a document by clicking the
"Knit" button at the top of the `index.Rmd` document.
The result should be a PDF
document which appears like the document below.
To render a document to *a different output type* (other than a PDF),
click the down arrow to the right of the "Knit" button, and select either the
gitbook or Word document format.
# To-Do List
- [x] Add auto-word-counting capability using `rmdfiltr` package internally.
- [ ] Fix `template.docx` does not take any effect on `jladown::jla_word()` output.
- [ ] Make a cover page including jla logo for `bookdown::gitbook()` output.