-
Notifications
You must be signed in to change notification settings - Fork 3
/
README.Rmd
97 lines (59 loc) · 4.13 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
---
title: Introducing learningR
output: github_document
editor_options:
chunk_output_type: console
---
<!-- badges: start -->
[](https://github.com/ablaette/learningR/actions)
<!-- badges: end -->
## learningR: An introduction to R
The repository is used for an introductory course to scientific programming and data visualisation with R.
## Installation
The package is a GitHub-only package at this stage. To avoid the overhead of installing the [devtools](https://CRAN.R-project.org/package=devtools) package which is usually used for installing packages directly from GitHub (using `devtools::install_github()`), I recommend using `remotes::install_github()`. Indeed, devtools only re-exports the original function of the [remotes](https://CRAN.R-project.org/package=remotes) package.
```{r install_from_github, eval = FALSE}
install.packages("remotes")
remotes::install_github("ablaette/learningR", build_vignettes = TRUE, dependencies = TRUE)
```
Setting arguments `build_vignettes` and `dependencies` as `TRUE` is important:
- The slides included in the package are technically realized as vignettes. We need to ensure that they are built (`build_vignettes = TRUE`).
- R packages used by the vignettes are suggested packages, `dependencies = TRUE` will ensure that these dependencies are installed if not yet present.
This installation mechanism works on macOS, Linux and Windows.
Experimentally, the package is also available via a "drat" (CRAN-style) repository. Install the package as follows:
```{r, eval = FALSE}
install.packages(pkg = "learningR", repos = "https://polmine.github.io/drat/")
```
## Using the package
### Viewing the slides
The slides are designed to work online as well as locally. If the learningR package is installed, use the following command to open a browser window that will show an overview over the slides within the package.
```{r show_overview, eval = FALSE}
browseVignettes(package = "learningR")
```
Then click on the respective HTML document to inspect one set of slides.
### Viewing R Markdown
To explore code included in the slides, you want to have access to the original R code. Within RStudio, choose among the R Markdown files the slides are based on using the following command.
```{r, eval = FALSE}
open_rmd_file()
```
The chosen file will be opened in RStudio.
### Classroom use
The slides are designed to work well in a classroom setting - including courses taught by video conference. In this scenario, you often want to show slides and the R console at the same time, to demonstrate how a piece of code works.
This is why we use [xaringan Presentations](https://bookdown.org/yihui/rmarkdown/xaringan.html): You can preview (show) slides within the Viewer pane of RStudio. At the same, the R console is available. To launch the 'infinite moon reader', ensure that the R Markdown document of the slides you want to use is the active document. The slides are launched in the RStudio Viewer pane as follows:
```r
servr::daemon_stop(1)
xaringan::inf_mr()
```
## Finding the slides online
The package is work in progress, only a part of the slides is ready for use. The following slides are available online:
- [Erste Schritte](https://ablaette.github.io/learningR/a_getting-started.html#1)
- [Installation von Paketen](https://ablaette.github.io/learningR/b_installation.html#1)
- [Datenstrukturen: Vektoren](https://ablaette.github.io/learningR/c_vektoren.html#1)
- [Matrizen - Listen - Tabellen](https://ablaette.github.io/learningR/d_data.frames.html#1)
- [Funktionen und Kontrollstrukturen](https://ablaette.github.io/learningR/e_kontrollstrukturen.html#1)
## License
The package is an [Open Educational Resource](https://de.wikipedia.org/wiki/Open_Educational_Resources) licensed under a Creative Commons License ([CC BY 4.0](https://creativecommons.org/licenses/by/4.0/deed.de)). Tha package may be used, shared and modified, but it is expected that authorship is attributed.
## Quoting the slides (the package)
To get a suggestion how to quote the package, use the `citation()` function:
```{r}
citation(package = "learningR")
```