Skip to content

Ressources à l'intention des formateurs

Juliette Engelaere-Lefebvre edited this page Mar 8, 2022 · 5 revisions

Utilisation de {savoirfR}

Le packages {savoirfR} a été développé et est maintenu par le groupe des référents R du ministère.
Il comprend à l'heure actuelle les exercices de trois modules de formation du parcours-r :

  • module 1 : « Socle : Premier programme en R »,
  • module 2 : « Socle : Préparation des données »,
  • module 5 : « Datavisualisation : produire des graphiques, des cartes et des tableaux ».

Il permet aux stagiaires de créer un projet RStudio dans lequel ils retrouveront les exercices présentés dans le support de cours, avec les données, les énoncés et les corrections directement accessibles.

L'utilisation de ce package est documentée ici : https://mtes-mct.github.io/savoirfR/index.html

Utilisation du SSP Cloud

Lors de formations présentielles, à l'aide de postes différents de ceux utilisés au quotidien par les stagiaires, la préparation de la formation peut rapidement tourner au casse-tête. La mise à niveau des postes de formation est une activité fort peu réjouissante et qui a peu d'intérêt pour le stagiaire s'il doit mettre à niveau seul son poste une fois de retour de formation.

Une solution qui évite de configurer chaque machine est proposée par la plateforme d'expérimentations en datasciences de l'INSEE. Le stagiaire passe par un navigateur web pour se connecter à la plateforme et peut très facilement y déployer une instance RStudio, adaptée au module de formation suivi. Cette solution a également l'avantage d'offrir aux stagiaires un environnement de travail confortable, disposant d'une importante puissance de calcul et de suffisamment de RAM.

Voici le mode opératoire à l'attention des formateurs.

Dès la programmation de la formation

Il est utile d'informer les administrateurs de la plateforme des dates de nos formations réalisées sur le SSP Cloud. Cela leur permet d'anticiper ou de décaler d'éventuelles maintenance qui perturberaient son déroulement. Cela assure en outre les formateurs d'une meilleure réactivité en cas de nécessité.

Cette information peut être réalisée via le salon dédié au SSP Cloud de Tchap.

Dès la liste des stagiaires connue

Demander aux stagiaires de se créer un compte sur : https://datalab.sspcloud.fr/home, en cliquant sur connexion en haut à droite. image

Toutes les adresses en gouv.fr sont automatiquement acceptées. D'autres motifs d'adresse e-mail d'institutions publiques le sont également. Des demandes de créations de compte pour des stagiaires dont l'adresse ne serait pas reconnue automatiquement peuvent être effectuées via le canal Tchap par le formateur, soit par message privé aux administrateurs du canal, soit en demandant la reconnaissance d'un nouveau motif d'adresse e-mail.

Prendre en main la plateforme

Dans le menu en haut à droite, ouvrir l'onglet formation et rechercher le cartouche Parcours R
ongletFormationSSP
Cette page est directement accessible via l'URL https://www.sspcloud.fr/formation?search=&path=%5B%22Parcours%20R%22%5D.

Choisir la formation correspondante et cliquer sur 'lire' pour accéder à la dernière version du support de formation officiel,

A la fin de la formation

  • Les stagiaires peuvent exporter leurs travaux depuis Rstudio :
    image

  • Il est demandé de supprimer les services lorsque la formation est terminée. Ne le faites pas avant la fin de la formation, vos travaux seraient perdus

Contribuer au maintien et à la mise à jours des supports

Les supports de formation du parcours-r sont élaborés et partagés grâce à la forge github. Cette forge facilite le travail collaboratif entre développeurs. Trois manières de contribuer à la maintenance des supports vous sont proposées : de la plus simple pour qui ne travaille pas avec git aujourd'hui, à la plus facile à intégrer pour les mainteneurs des supports. Quelle que soit la manière de collaborer qui vous convienne le mieux, pour intervenir sur cette plateforme, il vous est nécessaire de disposer d'un compte Github. Rendez-vous ici pour créer votre compte.

Les adresses des différents supports de modules sont récapitulées ici : https://github.com/MTES-MCT/parcours-r

Méthode 1 : ouvrir un ticket

Après vous être connecté.e, vous pouvez signaler un passage à mettre à jour en ouvrant un ticket (=issue) dans le projet du module concerné. Il vous est demandé y d'exposer le problème, de localiser le passage à revoir, et pourquoi pas de proposer une solution.

image

Au besoin, les tickets permettent d'échanger afin de bien comprendre le besoin et de définir collectivement la manière d'y répondre.

Le groupe de référents R procédera à la mise à jour et le support sera automatiquement mis à jour lorsque les corrections auront été versées sur la branche principale (main).

Proposer une rédaction facile à intégrer via une demande de fusion (pull request)

Deux solutions sont à votre disposition pour proposer une demande de fusion.

Méthode 2 : éditer les fichiers .Rmd en ligne

Github propose l'édition en ligne des fichiers. Après vous être identifié.e sur la plateforme, vous pouvez vous rendre directement sur le fichier à corriger pour l'éditer :
image
Vous pouvez rédiger vos propositions de modifications en ligne et demander à ce qu'elles soient intégrées à l'aide du bouton 'propose changes' :
image

Le groupe de référents R procédera à la mise à jour et le support sera automatiquement mis à jour lorsque les corrections auront été versées sur la branche principale (main).

Méthode 3 : à partir d'un support mis à jour localement

Les formateurs qui ont complétement adapté le support pour leur propres besoins préféreront surement signaler leurs modifications d'une seule opération. Cela nécessite un peu d'expérience (ou de formation 🙂) avec git.
Pour utiliser git et github avec RStudio, voir le tutoriel de configuration des postes : https://maeltheuliere.github.io/ateliers_rpackage/configuration.html et le support de formation 'Travail collaboratif avec R' de l'INSEE : https://linogaliana.gitlab.io/collaboratif/.

Pour cette solution, l'idée est de déposer votre bookdown corrigé sur votre espace github personnel grâce à git et d'effectuer une demande de fusion vers le repo officiel du module sur le compte github MTES-MCT.

1ère étape : créer une copie du support dans sa version MTES-MCT dans votre espace (fork)
image cela permettra d'avoir chez vous les dernières versions des scripts d'intégration continue, qui servent notamment à rendre le support.

**2e étape **: rapatriez ce fork en local Depuis RStudio, créez un nouveau projet, avec contrôle de version, sous git et renseigner l'url de votre repo
image
et renseigner l'url de votre repo, que vous pouvez récupérer sur votre fork github :
image
Cela peuplera votre nouveau projet RStudio avec les fichiers du projet tels qu'ils apparaissent sur le compte github du ministère.

3e étape : copiez-collez votre support de formation corrigé dans ce projet local et vérifier qu'il se compile correctement. Dans votre dossier RStudio local, copiez-collez les fichiers Rmd et les images nécessaires à la mise à jour du support. La version des packages utilisée pour rendre le support sont figées grâce à {renv}. Rendez-vous ici https://rstudio.github.io/renv/articles/renv.html, pour vous faire la main avec {renv}.

4e étape : poussez votre version du support sur votre compte github
A l'aide d'un push, vous pouvez envoyer sur votre compte github votre version du support de formation, en ayant préalablement coché les fichiers que vous avez modifiés et que vous souhaitez partager.
image

5e étape : ouvrez une demande de fusion vers le repos officiel MTES-MCT Depuis votre repo Github, à l'aide du bouton 'Contribute' vous pouvez ouvrir une demande de fusion vers le repo du ministère :
image

Cela informera les mainteneurs du support que vous souhaitez partager des modifications et les aidera à les incorporer.

Après examen, le groupe de référents R procédera à leur intégration et le support sera automatiquement mis à jour lorsque les corrections auront été versées sur la branche principale (main).

Contribuer à la rédaction et à la mise à jour des supports en devenant membre du G2R.

Si vous le souhaitez, le groupe des référents R du ministère (G2R) recrute ! Si vous êtes parvenus à faire une demande de fusion de votre version du support selon la méthode 3, ne vous posez pas de questions, vous avez tout à fait le niveau !
Signalez-vous sur le canal Ariane des formateurs R du ministère pour que notre gentil animateur vous intègre dans sa liste de personnes à convier aux réunions du groupe.
Il vous faudra également demander à intégrer les développeurs github du ministère pour pouvoir ensuite rejoindre la team parcours-r.