{"id":23052114,"url":"https://github.com/inseefrlab/utilitr","last_synced_at":"2025-04-05T01:05:14.989Z","repository":{"id":37083772,"uuid":"319657746","full_name":"InseeFrLab/utilitR","owner":"InseeFrLab","description":"Source of the utilitR French R documentation","archived":false,"fork":false,"pushed_at":"2024-12-12T14:03:46.000Z","size":25003,"stargazers_count":77,"open_issues_count":40,"forks_count":57,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-03-29T00:05:18.977Z","etag":null,"topics":["documentation","french-speaking","r","rstats","training"],"latest_commit_sha":null,"homepage":"https://book.utilitr.org/","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/InseeFrLab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-12-08T14:07:54.000Z","updated_at":"2025-03-19T11:14:45.000Z","dependencies_parsed_at":"2024-01-31T09:46:48.530Z","dependency_job_id":"bafa1dce-5ee8-4303-bb81-48b2b75bd64e","html_url":"https://github.com/InseeFrLab/utilitR","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InseeFrLab%2FutilitR","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InseeFrLab%2FutilitR/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InseeFrLab%2FutilitR/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InseeFrLab%2FutilitR/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/InseeFrLab","download_url":"https://codeload.github.com/InseeFrLab/utilitR/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247271518,"owners_count":20911587,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","french-speaking","r","rstats","training"],"created_at":"2024-12-16T00:07:21.128Z","updated_at":"2025-04-05T01:05:14.965Z","avatar_url":"https://github.com/InseeFrLab.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `utilitR` : une documentation utile pour `R`  \u003ca href='https://www.utilitr.org'\u003e\u003cimg src='resources/logo-utilitR.svg' align=\"right\" height=\"139px\" /\u003e\u003c/a\u003e\n\n\n\u003c!-- badges: start --\u003e\n[![build-doc Actions Status](https://github.com/InseeFrLab/utilitR/workflows/Production%20de%20la%20documentation/badge.svg)](https://github.com/InseeFrLab/utilitR/actions)\n[![Docker Pulls](https://img.shields.io/docker/pulls/inseefrlab/utilitr)](https://hub.docker.com/repository/docker/inseefrlab/utilitr/general)\n[![SSPcloud](https://img.shields.io/badge/SSPcloud-Tester%20via%20SSP--cloud-informational?logo=R)](https://datalab.sspcloud.fr/launcher/ide/rstudio?autoLaunch=true\u0026onyxia.friendlyName=«utilitr-tester»\u0026init.personalInit=«https%3A%2F%2Fraw.githubusercontent.com%2FInseeFrLab%2FutilitR%2Fmaster%2Fresources%2Finit_9juin.sh»\u0026service.image.version=«inseefrlab%2Futilitr%3Alatest»)\n\u003c!-- badges: end --\u003e\n\n\u003cbr\u003e\n\n## :one: Présentation du projet `utilitR`\n \nCode source pour le projet `utilitR`, documentation collaborative `R` \nfaite par des agents de l'**Insee** et du **Service Statistique Public**.\nElle a vocation à être validée annuellement afin de produire un guide des bonnes pratiques et des fiches techniques.\n\nElle prend la forme suivante :\n\n* la documentation principale qui est déployée à l'adresse \u003chttps://book.utilitr.org/\u003e ;\n* un guide des bonnes pratiques en `R` déployé à l'adresse \u003chttps://www.pratiques.utilitr.org/\u003e\n\nLorsqu'une version `PDF` sera mise à disposition, un lien direct de téléchargement sera \ndisponible. Chaque fiche, disponible sur le site web, peut être imprimée\navec une mise en page agréable grâce à un bouton dédié sur le site web.\n\nLes exemples sont construits sur des données ouvertes, disponibles sur www.insee.fr. \nLe package [`doremifasolData`](https://github.com/InseeFrLab/DoReMIFaSolData) facilite\nl'import de ces données dans la documentation. Le modèle de document est\nencapsulé dans un *package* `R` dédié: https://github.com/InseeFrLab/utilitr-template \n\nL'ensemble des ressources du projet `utilitR` sont disponibles sur https://www.utilitr.org\n\nUn environnement prêt à l'emploi est disponible pour les utilisateurs du `SSPCloud` en cliquant sur le [lien suivant](https://datalab.sspcloud.fr/launcher/ide/rstudio?autoLaunch=false\u0026init.personalInit=%C2%ABhttps%3A%2F%2Fgithub.com%2FInseeFrLab%2FutilitR%2Fblob%2Fmaster%2Finit_utilitr.sh%C2%BB\u0026service.image.custom.enabled=true\u0026service.image.custom.version=%C2%ABinseefrlab%2Futilitr%3Alatest%C2%BB) [![SSPcloud](https://img.shields.io/badge/SSPcloud-Tester%20via%20SSP--cloud-informational?logo=R)](https://datalab.sspcloud.fr/launcher/ide/rstudio?autoLaunch=false\u0026init.personalInit=%C2%ABhttps%3A%2F%2Fgithub.com%2FInseeFrLab%2FutilitR%2Fblob%2Fmaster%2Finit_utilitr.sh%C2%BB\u0026service.image.custom.enabled=true\u0026service.image.custom.version=%C2%ABinseefrlab%2Futilitr%3Alatest%C2%BB)\n\n\u003cbr\u003e\n\n## :two: Objectifs de la documentation :book:\n\n### Public cible\n\n**Cette documentation s'adresse à tous utilisateur de `R` dans le cadre d'un usage courant d'analyse de données.**\nElle est conçue pour aider les utilisateurs à réaliser des traitements statistiques usuels avec `R` et à produire des sorties (graphiques, cartes, documents).\n\nCette documentation présente succinctement les outils les plus adaptés à ces tâches, et oriente les utilisateurs vers les ressources documentaires pertinentes. En revanche, elle n'aborde pas les outils les plus avancés, notamment ceux utilisés dans un cadre de développement logiciel.\n\n### Structuration de la documentation\n\nLa documentation présentée dans book.utilitr.org a pour ambition de répondre à deux questions générales:\n\n* Comment réaliser des tâches standards avec `R` (importation et manipulation de données, exploitation d'enquêtes, graphiques...)?\n* Comment configurer `R` et `Rstudio` de manière à bénéficier de la richesse de cet écosystème ?\n\nA ces deux sujets s'ajoute une documentation sur les bonnes pratiques de développement avec `R`. \nCe guide des bonnes pratiques est disponible sur www.pratiques.utilitr.org\n\n### Remarques\n\nDeux points importants sont à noter:\n\n* **Cette documentation recommande les outils et les *packages* les plus adaptés au contexte d'utilisation de `R` à l'Insee**. Dans certains cas, ces recommandations peuvent ne pas être adaptées à d'autres contextes ou être amenées à changer lorsque le contexte interne évoluera. Une grande partie des recommandations sont néanmoins suffisamment générales pour ne pas être spécifiques au contexte Insee. Elles peuvent ainsi servir à de nombreux utilisateurs de données. \n* **Cette documentation recommande d'utiliser `R` avec `Rstudio`**, qui apparaît comme la solution la plus simple et la plus complète pour un usage courant de `R`, et qui est par ailleurs le choix effectué par l'Insee et de nombreuses institutions.\n\n\u003cbr\u003e\n\n## :three: Comment contribuer ?\n\n**Le projet `utilitR` est un projet collaboratif, évolutif, *open source* et ouvert à tous, auquel tous les agents peuvent contribuer.**\nLe projet est mené par un groupe de contributeurs qui en définissent eux-mêmes le contenu, la structure\net le calendrier. Les objectifs et l'approche collaborative du projet `utilitR` sont détaillés dans [`ce document`](Manifeste.md).\n\n**Toute personne qui le souhaite peut modifier ou compléter la documentation en fonction de ses connaissances et de ses expériences**, et toutes les contributions sont les bienvenues: compléments, corrections d'erreur, améliorations, questions... Il n'y a aucun prérequis, et aucun niveau minimal en `R` n'est demandé. Le dépôt de la documentation est situé [ici](https://github.com/InseeFrLab/utilitR). Toute personne intéressée à contribuer au projet est invitée à consulter le guide des contributeurs (`CONTRIBUTING.md`).\n\n\u003cbr\u003e\n\n## :four: Reproductibilité de la documentation\n\nLe projet `utilitR` a pour objectif de favoriser la reproductibilité et\nla pérennité des traitements statistiques avec `R`.\nCes principes s'appliquent également à la documentation produite: l'ensemble\ndes exemples sont construits à partir de données\ndisponibles sur le site www.insee.fr et les morceaux de code présents\nsont faits pour être reproductibles. Pour rendre la documentation plus\nreproductible, un certain nombre d'éléments de formattage ont été intégrés\ndans un package `R` proposant des modèles de documents standardisés. Il\npeut être installé de la manière suivante:\n\n```r\n# install.packages(\"remotes\")\nremotes::install_github(\"https://github.com/InseeFrLab/utilitr-template\")\n```\n\nLes éléments présents dans la documentation visent à être cohérents avec\nles recommandations émises par le comité de certification des packages `R` (`COPS`),\norgane interne visant à prescrire ou proscrire certains packages dans le cadre\nde la production statistique. \n\nPlus d'éléments pour faire tourner les codes sont disponibles \ndans ce [document](doc/extra_info.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finseefrlab%2Futilitr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finseefrlab%2Futilitr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finseefrlab%2Futilitr/lists"}