Modèle de fiche

Le nom de la fiche décrit la tâche qu’on veut réaliser en quelques mots.

Tâches concernées et recommandations

Quelques détails sur la tâche dont il s’agit

ImportantTâche concernée et recommandation

Dire en 4-5 lignes comment il est recommandé de procéder :

  • le ou les package(s) dont l’usage est recommandé ; si on recommande plusieurs packages, expliquer comment choisir lequel (en fonction de la taille des données, du format…)
  • les packages dont l’usage est déconseillé ;
  • les autres points de méthode essentiels.

Quelques détails sur comment réaliser la tâche avec les outils recommandés

Tip

Cette boîte colorée sert à donner un conseil. Son usage n’est évidemment pas obligatoire.

Note

Cette boîte colorée sert à faire une remarque. Son usage n’est évidemment pas obligatoire.

Réaliser la tâche, cas 1

Lorsqu’on est débutant, il faut utiliser la fonction super_fonction() du package super_package.

La fonction super_fonction() fonctionne comme ceci par défaut : blabla.

La fonction super_fonction() propose beaucoup d’options :

  • option1 : blabla ;
  • option2 : blabla ;
  • option3 : blabla.

Voici un premier exemple de code (le plus simple possible, en utilisant des données facilement disponibles sur le site de l’Insee) :

library(super_package)
output <- super_fonction(arguments)

Ne pas oublier d’expliquer ce qu’on obtient comme output.

Voici un second exemple de code, avec des options un peu plus avancées :

output <- super_fonction(arguments et options)

Réaliser la tâche, cas 2

Lorsqu’on est plus avancé, on peut utiliser la fonction hyper_fonction() du package hyper_package.

  • Comportement par défaut ;
  • Principales options ;
  • Exemples de code.

Quelques bonnes pratiques

Quelques conseils généraux sur la façon de s’y prendre.

  • Faut-il préprocesser les données avant de réaliser la tâche ;
  • Comment minimiser les temps de calculs/la charge en RAM.

Sources

Si le rédacteur de la fiche a réutilisé des ressources externes en français disponible en licence libre, il faut indiquer ici l’URL des ressources, le nom des auteurs et la licence de réutilisation de ces ressources.

Pour en savoir plus

  • la documentation des packages ;
  • les vignettes et cheatsheets si elles existent ;
  • les formations proposées par l’Insee ;
  • les formations/tutoriels disponibles sur internet.

Dans la mesure du possible, il faut veiller à proposer des ressources en français.