{"id":13690560,"url":"https://inseefrlab.github.io/DoReMIFaSol/","last_synced_at":"2025-05-02T11:31:20.398Z","repository":{"id":42222810,"uuid":"256992558","full_name":"InseeFrLab/DoReMIFaSol","owner":"InseeFrLab","description":"Téléchargement des données sur le site de l'Insee","archived":false,"fork":false,"pushed_at":"2025-04-26T04:08:35.000Z","size":187119,"stargazers_count":32,"open_issues_count":10,"forks_count":12,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-26T05:28:00.156Z","etag":null,"topics":["api","api-client","insee","open-data","r","r-package","rstats","rstats-package","sirene"],"latest_commit_sha":null,"homepage":"https://InseeFrLab.github.io/DoReMIFaSol/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","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","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,"zenodo":null}},"created_at":"2020-04-19T12:23:00.000Z","updated_at":"2025-03-26T12:55:32.000Z","dependencies_parsed_at":"2023-01-19T09:30:24.909Z","dependency_job_id":"f9823e17-6837-43f3-84ee-a02ad684ee42","html_url":"https://github.com/InseeFrLab/DoReMIFaSol","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InseeFrLab%2FDoReMIFaSol","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InseeFrLab%2FDoReMIFaSol/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InseeFrLab%2FDoReMIFaSol/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InseeFrLab%2FDoReMIFaSol/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/InseeFrLab","download_url":"https://codeload.github.com/InseeFrLab/DoReMIFaSol/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251658202,"owners_count":21622819,"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":["api","api-client","insee","open-data","r","r-package","rstats","rstats-package","sirene"],"created_at":"2024-08-02T17:00:21.840Z","updated_at":"2025-05-02T11:31:20.392Z","avatar_url":"https://github.com/InseeFrLab.png","language":"R","funding_links":[],"categories":[":package: Packages :package:"],"sub_categories":[],"readme":"# Récupérer et utiliser les données de l'Insee avec R / Get and use Insee's data with R\n\n\u003cimg src=\"https://github.com/inseeFrLab/doremifasol/raw/master/inst/sticker/hex_logo_v2.png\" width=\"150\" height=\"150\" align=\"right\" alt=\"DoReMIFaSol logo\" /\u003e\n\n\u003c!-- badges: start --\u003e\n[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)\n[![build-artifacts](https://github.com/InseeFrLab/DoReMIFaSol/actions/workflows/build-artifacts.yml/badge.svg)](https://github.com/InseeFrLab/DoReMIFaSol/actions/workflows/build-artifacts.yml)\n[![R-CMD-check](https://github.com/InseeFrLab/DoReMIFaSol/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/InseeFrLab/DoReMIFaSol/actions/workflows/R-CMD-check.yaml)\n[![License:MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Coverage status](https://codecov.io/gh/InseeFrLab/DoReMIFaSol/branch/master/graph/badge.svg?token=FM7HW4DSW5)](https://codecov.io/gh/InseeFrLab/DoReMIFaSol)\n[![CRAN status](https://www.r-pkg.org/badges/version/doremifasol)](https://cran.r-project.org/package=doremifasol)\n\u003c!-- badges: end --\u003e\n\n## Français\n\n### 🚀 Nouvelle fonctionnalité\n\nLe catalogue de données intègre désormais les données mises à disposition dans [l'API Melodi](https://portail-api.insee.fr/catalog/all). Outre la [liste de données](https://raw.githubusercontent.com/InseeFrLab/DoReMIFaSol/refs/heads/master/data-raw/liste_donnees.json) disponible dans le _package_, les données listées dans le catalogue de Melodi sont intégrées _via_ [ce fichier](https://minio.lab.sspcloud.fr/pierrelamarche/melodi/liste_donnees.json) qui est mis quotidiennement à jour.\n\n### De quoi s'agit-il ?\n\nLe _package_ `doremifasol` (_Données en R Mises à disposition par l’Insee et Facilement Sollicitables_) permet d'importer facilement dans R des données mises à disposition sur le site de l'Insee.\n\nIl offre deux fonctionnalités principales :\n\n* télécharger et importer dans R des fichiers disponibles sur insee.fr (Base Permanente des Équipements, Recensement de Population, Filosofi...), **y compris les données mises à disposition _via_ Melodi** ;\n* requêter l'[API](https://api.insee.fr/catalogue) Sirene et recupérer les résultats dans R.\n\nL'objectif du _package_ est de rendre transparentes les différentes tâches à réaliser avant de pouvoir traiter les données : recherche sur le site, téléchargement, décompression, import dans R...\n\nIdéal pour pratiquer son solfège en R sur des données françaises !\n\nPour installer le package :\n\n```r\n# install.packages(\"remotes\")\nremotes::install_github(\"InseeFrLab/doremifasol\", build_vignettes = TRUE)\n```\n\n### Quelles données sont disponibles ?\n\nPour trouver quelles données le package peut aller récupérer sur le site de l'Insee, on peut commencer par explorer interactivement les [données disponibles](https://inseefrlab.github.io/DoReMIFaSol/articles/donnees_dispo.html).\n\nCela permet notamment de connaître les identifiants (noms courts) et millésimes qui seront à spécifier aux fonctions de téléchargement.\n\n_Le package a vocation à intégrer de nouveaux jeux de données dès qu'ils sont mis en ligne. Ce processus n'est toutefois pas automatisé. Voir la section **\u003ca href=#contribuer\u003eContribuer\u003c/a\u003e** pour suggérer l'ajout de nouvelles données._\n\n### Exemples d'usages\n\n#### Les données du recensement de population\n\nLe premier exemple concerne les données du recensement librement accessibles sur le site de l'Insee. Ce sont des données très volumineuses, et sauf à disposer de capacités de calcul conséquentes, il n'est en général pas possible de charger l'ensemble des données en mémoire. Pour cela, le _package_ `doremifasol` permet de sélectionner les colonnes que l'on souhaite charger en mémoire, une fois le fichier téléchargé. Ainsi, un utilisateur qui voudrait connaître par commune le nombre de résidences principales en 2016 aura besoin des variables `COMMUNE` - le code commune - et `CATL` - la catégorie d'occupation du logement - de la table `logement` :\n\n```r\ndonnees_rp \u003c- telechargerDonnees(\"RP_LOGEMENT\", date = 2016, vars = c(\"COMMUNE\", \"IPONDL\", \"CATL\"))\n```\n\n#### Filosofi\n\nL'Insee met également à disposition un certain nombre d'indicateurs relatifs à la distribution des revenus et à la pauvreté au niveau communal, voire infra-communal. Ces données sont mises à jour chaque année à partir des sources fiscales ; il s'agit de la source \"Filosofi\". Ainsi, il est possible de télécharger ces indicateurs au niveau de la commune, pour l'ensemble des ménages par exemple, grâce à la syntaxe suivante :\n\n```r\ndonnees_filosofi \u003c- telechargerDonnees(\"FILOSOFI_DISP_COM_ENS\", date = 2017)\n```\n\nCes données sont déclinées pour différentes catégories de ménages, et de la même manière peuvent être téléchargées grâce au _package_ `doremifasol`.\n\n#### Estimations localisées d'emploi en France\n\nDe la même manière que les données fiscales permettent de fournir des statistiques à un niveau géographique fin, d'autres sources administratives permettent de construire des estimations du nombre d'emplois présents dans les différentes communes du territoire français. Il s'agit des Estimations d'Emploi Localisées, qu'il est possible de récupérer en `R` grâce à la syntaxe suivante :\n\n```r\ndonnees_estel \u003c- telechargerDonnees(\"ESTEL_T201\", date = 2018)\n```\n\n#### Requêter une API REST : le répertoire d'entreprises Sirene\n\nSupposons que l'on cherche maintenant à récupérer l'ensemble des établissements rattachés à une unité légale créée le 1er janvier 2020 ; pour cela, on peut par exemple envoyer une requête sur l'API REST Sirene de l'Insee. Pour cela, il faut au préalable avoir configuré un accès à l'API REST de l'Insee et passer en variables d'environnement les données d'identification. La procédure est expliquée par exemple [ici](https://github.com/InseeFrLab/apinsee#exemple). Une fois cela réalisé, la requête peut se faire facilement au travers de `doremifasol` de la manière suivante :\n\n```r\netablissements \u003c- telechargerDonnees(\"SIRENE_SIRET\", \n                                     argsApi = list(q = \"dateCreationUniteLegale:2020-01-01\"))\n```\n\nOn fait alors face à une liste contenant plusieurs `data.frame` (6 au total) :\n* une table contenant l'ensemble des informations sur les établissements en question ;\n* deux tables contenant l'ensemble des informations sur les unités légales de ces établissements, en distinguant les unités dites purgées des autres ;\n* deux tables contenant les informations sur l'adresse de ces établissements ;\n* une table détaillant les informations historisées de ces établissements - c'est-à-dire les différentes modifications qu'ont connues les établissements entre leur création et la date de référence - ici par défaut la date de téléchargement.\n\n### Contribuer\n\nAgent du Service Statistique Public, ou utilisateur des données mises à disposition sur le site de l'Insee, vous constatez qu'il manque dans la [liste des données](https://inseefrlab.github.io/DoReMIFaSol/articles/donnees_dispo.html) référencées dans `doremifasol` une source de données que vous utilisez ? Vous pouvez contribuer à `doremifasol`, sans nécessairement coder en `R`. Pour plus de détais, vous pouvez consulter la [documentation à ce sujet](https://github.com/InseeFrLab/DoReMIFaSol/blob/master/CONTRIBUTING.md).\n\n\n## English\n\n### 🚀 New Feature\n\nThe data catalog now includes data made available in the [Melodi API](https://portail-api.insee.fr/catalog/all). In addition to the [list of data](https://raw.githubusercontent.com/InseeFrLab/DoReMIFaSol/refs/heads/master/data-raw/liste_donnees.json) available in the package, the data listed in the Melodi catalog is integrated via [this file](https://minio.lab.sspcloud.fr/pierrelamarche/melodi/liste_donnees.json) which is updated on a daily basis.\n\n### What is it about?\n\n`doremifasol` (data with R made available by Insee and easily retrievable in French) is a R package mainly aiming at showing off data available on Insee's website (Insee, for the French Institute for Statistics and Economic Studies), helping the user to put them on stage and extract the information they carry. So it is about analysing data, creating maps, quantifying phenomenons and in general using the data without the painful effort to retrieve them on the website, as well as import them into R's memory. The name of the _package_ stands for the five first notes of music, and pushing the metaphore, underlines its aim at helping the users to easily pratice their _solfège_ in R.\n\nTo install the package:\n\n```r\n# install.packages(\"remotes\")\nremotes::install_github(\"InseeFrLab/doremifasol\", build_vignettes = TRUE)\n```\n\n### Which data is available?\n\nYou may begin by exploring interactively [which data](https://inseefrlab.github.io/DoReMIFaSol/articles/donnees_dispo.html) the package can fetch on Insee website with.\n\nThis is also a way to find out the identifiers (short names) and years to be passed as parameters to the downloading functions.\n\n_New data sources can be added to the package as soon as they are available online. However, this process is not automated. See the **\u003ca href=#contributing\u003eContributing\u003c/a\u003e** section for suggesting package administrators to add new sources._\n\n### A few examples\n\n#### Census data\n\nA first example of use of the package is related to the rolling Census implemented in France on a yearly basis. It concerns voluminous data that prove to be hard to load into R's memory on most of the machines. To adress the data size issue, the package `doremifasol` makes it possible to resize the data and only imports columns that are of interest for the user. Assume that one is interested in knowing the number of main residences for each municipality on the French territory in 2016, that one will only need three variables from the table `logement` (dwelling in French), `COMMUNE` the zip code, `IPONDL` the weight of the dwelling and `CATL` indicating the status of occupation:\n\n```r\ndonnees_rp \u003c- telechargerDonnees(\"RP_LOGEMENT\", date = 2016, vars = c(\"COMMUNE\", \"IPONDL\", \"CATL\"))\n```\n\n#### Data on income distribution and poverty\n\nShould you now be interested in data on income distribution, you may download information on income percentiles and poverty rate at the municipality level based on tax data, also knwow as 'Filosofi'. Those data are update every year. You may fetch these data for year 2017 for instance thanks to the following command:\n\n```r\ndonnees_filosofi \u003c- telechargerDonnees(\"FILOSOFI_DISP_COM_ENS\", date = 2017)\n```\n\n#### Data on employment\n\nTax data are very convenient to carry out information on income distribution at municipality level, so are data coming from registers on employment.\n\n#### Requesting an API REST on the firms' register _Sirene_\n\n\n### Contributing\n\nAs non French-speaking user of Insee's website, you are using data that turn out not to be listed [there](https://github.com/InseeFrLab/DoReMIFaSol/blob/master/data-raw/liste_donnees.csv) in the package `doremifasol`. You may notify the maintainer of this project and even more, could you code in `R` or not. Please report to the [dedicated documentation](https://github.com/InseeFrLab/DoReMIFaSol/blob/master/CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/inseefrlab.github.io%2FDoReMIFaSol%2F","html_url":"https://awesome.ecosyste.ms/projects/inseefrlab.github.io%2FDoReMIFaSol%2F","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/inseefrlab.github.io%2FDoReMIFaSol%2F/lists"}