inst/extdata
Chaque jeu de données doit être limité en taille à quelques centaines de lignes et quelques colonnes.
Compléter le fichier extdata/list_data_modules.csv en
rajoutant une ligne pour chaque dataset du module.
inst/vignettes/nom_du_module/
Chaque fichier d’exercice doit être nommé exoN.Rmd ou
exoN.rmd ou encore exoN.rmarkdown.
Il commence par :
-–
title: “Exercices X - module Y”
-–
où X est le numéro de l’exercice et Y le numéro du module.
Suivent :
La solution est introduite par la ligne :
‘Résultat attendu :’
Commence ensuite le chunk contenant les lignes de corrigé.
Ce chunk est nommé ‘modY_exo1_solution’; par exemple :
```{r mod5_exo1_solution, message=FALSE, warning=FALSE}
Knitter la vignette pour vérifier qu’elle compile.
N’oubliez pas de simuler l’installation du package avec
devtools::load_all(".") ou lancez un
Install et Restart pour que les fonctions
system.file() puissent trouver les fichiers que vous venez
d’ajouter dans inst.
Exception : les corrections du module 6 Publications
avec Rmarkdown sont des fichiers .Rmd entiers, on ne peut pas suivre le
même process. Les Rmd de correction sont à placer directement dans
inst/rstudio/templates/project/ressources/m6/corrections.
Le résultat est présenté dans le support de cours ou dans le site de
savoirfR par e-frame depuis https://mtes-mct.github.io/savoirfR/cheesedown/.
Dans le dossier qui centralise la saisie des exercices (inst/vignettes/m6), on ne met que la consigne de l’exercice + l’e-frame.
Chaque énoncé/corrigé d’exercice doit figurer :
/inst/rstudio/templates/project/ressource)vignette)La procédure proposée permet de tenir les différents supports cohérents entre eux au cours du temps et évite les multiples manipulations de mise à jour.
Pour propager les vignettes d’exercice écrites précédemment dans
inst/vignettes/nom_du_module/ vers le projet du stagiaire,
exécuter extract_r_files(module = Y) et consignez-le dans
le fichier devstuff_history.R du dossier dev
s’il n’est pas déjà inscrit.
Vérifier que les fichiers R ont bien été extraits dans les dossiers :
inst/rstudio/templates/project/ressources/mY/enonces
inst/rstudio/templates/project/ressources/mY/corrections
Les ajuster à la main au besoin.
Chaque vignette de module rassemble les consignes des différents exercices et visualise le résultat à obtenir, sans dévoiler la correction.
Pour appeler l’exercice dans la vignette ou dans parcours-r, il faut utiliser un chunk. Par exemple pour l’exercice 1 du module 5 :
```{r mod5_exo1, child=charge_exo(“m5”, “exo1.rmd”), echo=FALSE}
```
Compiler votre vignette pour la vérifier.
Ouvrez le projet RStudio dédié au module dont vous venez de mettre à jour les exercices dans {savoirfR}. Remplacez y les consignes par :
```{r modY_exoX, child=charge_exo(“mY”, “exoX.rmd”), echo=FALSE}
```
Remplacez y les corrigés par :
```{r modY_exoX_solution, child=charge_exo(“mY”, “exoX.rmd”),
echo=TRUE}
```
faites un check du package
appuyer sur install & restart
mettez-vous à la place du stagiaire en créant un projet d’exercices avec {savoirfR} du module mis à jour.
Une fois la branche master à jour de vos modifications, constatez les améliorations que vous avez apportées sur https://mtes-mct.github.io/savoirfR/index.html.
Une fois la branche master à jour de vos modifications, constatez les améliorations que vous avez apportées sur le support à partir de https://mtes-mct.github.io/parcours-r/ .