-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.Rmd
104 lines (64 loc) · 5.69 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
---
title : "apathe: American Psychological Association Thesis<br />with R Markdown"
output: github_document
---
```{r include = FALSE}
if(!requireNamespace("depgraph", quietly = TRUE)) remotes::install_github("crsh/depgraph")
```
<!-- README.md is generated from README.Rmd. Please edit that file -->
[]( https://cran.r-project.org/package=apathe) [](https://www.repostatus.org/#wip)  [](https://github.com/crsh/apathe/actions/workflows/R-CMD-check.yaml) [](https://app.codecov.io/gh/crsh/apathe) [](https://github.com/crsh/apathe/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
**apathe** is an R package that facilitates writing computationally reproducible student theses that conform to the American Psychological Association (APA) manuscript guidelines (6th Edition).
The package provides an [R Markdown](https://rmarkdown.rstudio.com/) template that can be used with (or without) [RStudio](https://posit.co/) to create PDF documents (using the [apa6](http://www.ctan.org/pkg/apa6) LaTeX class).
**apathe** is built on top of the package [**papaja**](https://github.com/crsh/papaja) but is tailored to the specific requirements of student theses and omits some features for simplicity.
If you believe you have found a bug or would like to request a new feature, [open an issue](https://github.com/crsh/apathe/issues) on Github and provide a [minimal complete verifiable example](https://stackoverflow.com/help/minimal-reproducible-example).
## Example
TBD
## Installation
To use **apathe** you need either a recent version of [RStudio](https://posit.co/) or [pandoc](https://pandoc.org/).
You additionally need a [TeX](https://en.wikipedia.org/wiki/TeX) distribution; we recommend you use [TinyTex](https://yihui.org/tinytex/), which can be installed from within R:
```{r eval = FALSE}
if(!requireNamespace("tinytex", quietly = TRUE)) install.packages("tinytex")
tinytex::install_tinytex()
```
Using other TeX distributions is possible.
Please refer to the [**papaja** manual](https://frederikaust.com/papaja_man/introduction.html#getting-started) for detailed installation instructions.
**apathe** is not yet available on CRAN but you can install it from this GitHub repository:
```{r install_papapja, eval = FALSE}
# Install remotes package if necessary
if(!requireNamespace("remotes", quietly = TRUE)) install.packages("remotes")
# Install the stable development version from GitHub
remotes::install_github("crsh/apathe")
```
## Usage
Once **apathe** is installed, you can select the APA-style thesis template when creating a new R Markdown file through the RStudio menus.
To add citations, specify your bibliography-file in the YAML front matter of the document (`bibliography: my.bib`) and start citing (for details, see pandoc manual on the [citeproc extension](https://pandoc.org/MANUAL.html#extension-citations). You may also be interested in [**citr**](https://github.com/crsh/citr), an R Studio addin to swiftly insert Markdown citations and [R Studio's visual editor](https://rstudio.github.io/visual-markdown-editing/), which also enables swiftly [inserting citations](https://rstudio.github.io/visual-markdown-editing/citations.html).
### Reporting analysis results
**papaja** provides
- Functions to **typeset** the results from **statistical analyses**,
- functions to create **tables**, and
- functions to create **figures** in accordance with APA guidelines.
For a comprehensive introduction to **papaja**, see the [README](https://github.com/crsh/papaja) or the current draft of the [manual](https://frederikaust.com/papaja_man/).
## Citation
Please cite **apathe** if you use it.
`r attr(unclass(citation("apathe"))[[1]], "textVersion")`
For convenience, you can [use `cite_r()`](https://frederikaust.com/papaja_man/writing.html#citing-r-and-its-packages) or copy the reference information returned by `citation('apathe')` to your BibTeX file:
~~~bibtex
```{r echo = FALSE, results = "asis"}
print(citation("apathe"), style = "Bibtex")
```
~~~
## Contribute
[](https://github.com/crsh/apathe/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) [](https://github.com/crsh/apathe/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation)
Like **apathe** and want to contribute?
We highly appreciate any contributions to the R package or its documentation.
Take a look at the [open issues](https://github.com/crsh/apathe/issues) if you need inspiration.
### Code of Conduct
Please note that the **apathe** project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
## Package dependencies
```{r dep-plot, echo = FALSE, fig.width = 10, fig.height = 9, message = FALSE, warning = FALSE}
depgraph::plot_dependency_graph(
pkg = "."
, repos = "https://cran.rstudio.com/"
)
```