# Documentation de la chaine EEC en R <!-- Put the link to this slide here so people can follow --> slide: https://hackmd.io/@d_bGtSM2RTqgFJDvA6YqfA/S1T5pjkq6 --- ## Contexte - traduction de la chaine aval SAS en R - projet Gitlab : https://gitlab.insee.fr/dera/eec/aval-r - chaine longue et modulaire - plusieurs niveaux de documentation --- ## Le README - fichier markdown (.md) à la racine du projet : pré-requis pour faire tourner la chaîne - comment récupérer le projet en local - l'objectif du projet en quelques lignes - la structure du projet (fichiers, dossiers) - les étapes nécessaires pour lancer la chaîne - les personnes à contacter ---- ### Exemple de README  ---- ### Exemple de README  ---- ### Exemple de README  https://gitlab.insee.fr/dera/eec/aval-r/-/blob/master/README.md --- ## La documentation Roxygen - documentation au sein des scripts R selon un format spécifique : description opérationnelle des fonctions - titre de la fonction - description succinte de la fonction - paramètres pris par la fonction - packages utilisés - ce que renvoie la fonction - exemple(s) d'utilisation ---- ### Exemple de documentation Roxygen  https://gitlab.insee.fr/dera/eec/aval-r/-/blob/master/R/get_isoalpha2code.R ---- ### Exemple de documentation Roxygen  ---- ### Exemple de documentation Roxygen  --- ## Le Wiki - projet à part, associé au projet Git, constitué de fichiers markdown : documentation détaillée de la chaîne et axée métier - introduction générale - parties numérotées et associées à chaque étape de la chaîne ---- ### Exemple de Wiki  Renvoi dans le Readme :  ---- ### Exemple de Wiki  https://gitlab.insee.fr/dera/eec/aval-r/-/wikis/home --- ### Pour conclure - **Readme** : une synthèse opérationnelle du projet - **Documentation Roxygen** : une description opérationnelle de chaque fonction R - **Wiki** : une documentation détaillée et métier de la chaîne associée au projet :arrow_right: documentation proche du code --- ### Merci ! :handshake: