Skip to content

#32 renv setup #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
pr130 wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft

#32 renv setup #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4168bdf
#32 renv setup
pr130 Apr 5, 2023
4fb3fd5
Remove install_github for packages
selinaZitrone Apr 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .Rprofile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
source("renv/activate.R")
31 changes: 31 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,34 @@ Die Lernplattform basiert auf dem CRAN [learnr-Package](https://cran.r-project.o
## Technische Details
Entwickler:innen finden Informationen zu den technischen Anforderungen (R-Versionen und benötigte Packages) unter "requirements.txt". In der Datei "lernplattform.Rmd" fließen die einzelnen Kapitel zusammen. Dort sind auch sämtliche Einstellungen zum "Set-Up" enthalten. Sollen R-Objekte über mehrere Kapitel/Übungen zugreifbar sein, müssen sie im Set-Up Code Chunk definiert werden.
! Achtung: Die Spracheinstellungen bitte immer prüfen. !

# Developer Information
## `renv`: Paketverwaltung
[`renv`](https://rstudio.github.io/renv/articles/renv.html) bringt lokales R-Dependency Management in unser Projekt, d.h. es erkennt und verwaltet die benötigten R Pakete. `renv` verwendet ein Lockfile (`renv.lock`), um den Zustand der lokalen R Library zu einem bestimmten Zeitpunkt zu erfassen.
Basierend auf Präsenz von `renv.lock` sollte RStudio automatisch erkennen, dass es benötigt wird und die entsprechende Version von `renv` in die Library herunterladen und installieren. Nachdem dies abgeschlossen ist, kann `renv::restore()` verwendet werden, um die Projektbibliothek lokal auf dem Rechner wiederherzustellen.
Wenn neue Pakete verwendet werden, installiert `install.packages()` die Pakete nicht global, sondern in einer Umgebung ("environment"), die nur für unser Projekt verwendet wird. Diese lokale Library befindet sich in `renv/library` finden (es sollte nicht nötig sein, diese Dateien zu editieren).
Wenn `renv` fehlschlägt, wird ein Fehler angezeigt. Das kann z.B. der Fall sein wenn R zum ersten Mal gestartet wird, nachdem das Repository geklont wurde:


```
renv::restore()
This project has not yet been activated. Activating this project will ensure the project library is used during restore. Please see ?renv::activate for more details. Would you like to activate this project before restore? [Y/n]:
```


Bestätige den Prompt mit "Y" und R wird `renv::restore()` ausführen und somit alle Pakete herunterladen und installieren.

`renv` benutzt ein lokales `.Rprofile` und `renv/activate.R` Skript, um unsere Dependencies zu verwalten.

### Hinzufügen eines neuen Packages
Wenn du ein neues Package hinzufügen möchtest, kannst du es wie üblich installieren (`install.packages` usw.).
Dann fügst du mithilfe der `snapshot` Funktion das Package zu `renv.lock` hinzu:

```
renv::snapshot()
```

Committe und pushe das `renv.lock` zu GitHub.

Andere Teammitglieder können dann wiederum `renv::restore()` ausführen, um die hinzugefügten Packages auf ihrem Laptop zu installieren.

4 changes: 0 additions & 4 deletions daten/flip_for_correlaid/flip_for_correlaid.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,6 @@ output:
</div>
---
```{r load_packages, message=FALSE, warning=FALSE, include=FALSE}
# devtools::install_github("rstudio/fontawesome")
# remotes::install_github("gadenbuie/xaringanExtra")
# remotes::install_github("gadenbuie/countdown")

library(fontawesome)
library(xaringanthemer)
library(countdown)
Expand Down
4 changes: 0 additions & 4 deletions daten/flip_for_correlaid_color/flip_for_correlaid_color.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,6 @@ output:
</div>
---
```{r load_packages, message=FALSE, warning=FALSE, include=FALSE}
# devtools::install_github("rstudio/fontawesome")
# remotes::install_github("gadenbuie/xaringanExtra")
# remotes::install_github("gadenbuie/countdown")

library(fontawesome)
library(xaringanthemer)
library(countdown)
Expand Down
4 changes: 0 additions & 4 deletions daten/flip_for_correlaid_facet/flip_for_correlaid_facet.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,6 @@ output:
</div>
---
```{r load_packages, message=FALSE, warning=FALSE, include=FALSE}
# devtools::install_github("rstudio/fontawesome")
# remotes::install_github("gadenbuie/xaringanExtra")
# remotes::install_github("gadenbuie/countdown")

library(fontawesome)
library(xaringanthemer)
library(countdown)
Expand Down
4 changes: 0 additions & 4 deletions daten/flip_for_correlaid_themes/flip_for_correlaid_themes.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,6 @@ output:
</div>
---
```{r load_packages, message=FALSE, warning=FALSE, include=FALSE}
# devtools::install_github("rstudio/fontawesome")
# remotes::install_github("gadenbuie/xaringanExtra")
# remotes::install_github("gadenbuie/countdown")

library(fontawesome)
library(xaringanthemer)
library(countdown)
Expand Down
17 changes: 0 additions & 17 deletions lernplattform.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,6 @@ runtime: shiny_prerendered
---

```{r setup, include=FALSE}
# remotes::install_github("rstudio/learnr")
# remotes::install_github("rstudio/gradethis")
# suppressWarnings(if (!require("pacman")) install.packages("pacman"))
# pacman::p_load(anytime,
# clisymbols,
# countdown,
# flipbookr,
# ggthemes,
# gtrendsR,
# prismatic,
# servr,
# tidylog,
# xaringan,
# xaringanExtra,
# xaringanthemer,
# install = TRUE,
# update = FALSE)
library(gradethis)
library(learnr)
library(rio)
Expand Down
Loading