doremifasol

https://inseefrlab.github.io/DoReMIFaSol
Admin
doremifasol is an R package for downloading and importing data from the French National Institute of...
Tokens:11,724
Snippets:73
Trust Score:9.7
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Example: millesimesDisponibles("RP_LOGEMENT")

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/millesimesDisponibles.html

Example call with the data source 'RP_LOGEMENT'. The output shows the available vintages from 2010 to 2021.

```r
millesimesDisponibles("RP_LOGEMENT")
#>  [1] "2010" "2011" "2012" "2013" "2014" "2015" "2016" "2017" "2018" "2019"
#> [11] "2020" "2021"
```

--------------------------------

### Install doremifasol package

Source: https://inseefrlab.github.io/DoReMIFaSol/index.html

Installs the doremifasol package from GitHub. The commented line installs the remotes package if needed.

```r
# install.packages("remotes")
remotes::install_github("InseeFrLab/doremifasol", build_vignettes = TRUE)
```

--------------------------------

### Example: load BPE data with chargerDonnees

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/chargerDonnees.html

Example usage of chargerDonnees with a file downloaded via telechargerFichier. The code is wrapped in \dontrun to prevent execution during package checks.

```r
if (FALSE) { # \dontrun{
dl_bpe <- telechargerFichier(donnees = "BPE_ENS")
bpe <- chargerDonnees(dl_bpe)} # }
```

--------------------------------

### Example: call sirets_successeurs with SIRET vector

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/sirets_successeurs.html

Example call to `sirets_successeurs` with three SIRET numbers. Wrapped in `if (FALSE)` to prevent execution during package checks.

```r
if (FALSE) { # \dontrun{

sirets_successeurs(c("30070230500040", "30137492200120", "30082187300019"))
} # }
```

--------------------------------

### Example: donnees_dispo() with default parameters

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/donnees_dispo.html

Calls donnees_dispo() with no arguments, displaying the first 10 rows of the dataset table. The output shows columns: Collection, Description, Nom court, Date de référence, Taille (Mo), Melodi, Documentation sur insee.fr. The table includes pagination controls and a search box.

```R
donnees_dispo()
```

--------------------------------

### telechargerFichier examples

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/telechargerFichier.html

Example usage of telechargerFichier. The first call downloads the BPE_ENS dataset without specifying a date; the second downloads RP_LOGEMENT for the 2016 vintage. Wrapped in \dontrun{} so it is not executed during package checks.

```r
if (FALSE) { # \dontrun{
telechargerFichier(donnees = "BPE_ENS")

telechargerFichier("RP_LOGEMENT", date = "2016")
} # }
```

--------------------------------

### Example: donnees_dispo("commune") with search filter

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/donnees_dispo.html

Calls donnees_dispo() with the search term "commune", filtering the table to show only datasets related to communes. The output shows 10 rows out of 34 filtered results, with columns: Collection, Description, Nom court, Date de référence, Taille (Mo), Melodi, Documentation sur insee.fr.

```R
donnees_dispo("commune")
```

--------------------------------

### Exemples d'appels à consulter()

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/consulter.html

Exemples d'utilisation de `consulter()` pour ouvrir la page, spécifier un millésime et récupérer uniquement l'URL, avec le retour de l'URL affiché.

```r
consulter(donnees = "BPE_ENS")
consulter("RP_LOGEMENT", date = "2016")
# Pour seulement obtenir l'URL de la page
consulter("RP_LOGEMENT", date = "2016", url_only = TRUE)
#> [1] "https://www.insee.fr/fr/statistiques/4229099"
```

--------------------------------

### Exemple d'utilisation de telechargerDonnees

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/telechargerDonnees.html

Exemple d'utilisation de la fonction pour télécharger des fichiers depuis insee.fr et utiliser l'API Sirene. Le code est enveloppé dans `if (FALSE) { # \dontrun{ ... } }` pour éviter l'exécution lors des tests.

```R
if (FALSE) { # \dontrun{

# fichiers sur insee.fr
bpe_ens_2019 <- telechargerDonnees(donnees = "BPE_ENS")
rp_log <- telechargerDonnees("RP_LOGEMENT", date = "2016", vars = c("COMMUNE", "IPONDL", "CATL"))

# utilisation de l'API Sirene
telechargerDonnees("SIRENE_SIREN",         
                   argsApi = list(q = "dateCreationUniteLegale:2021-03-01", nombre = 100))
telechargerDonnees("SIRENE_SIRET",         
                   argsApi = list(q = "codeCommuneEtablissement:92046 
                                       AND categorieJuridiqueUniteLegale:9220"))
telechargerDonnees("SIRENE_SIRET_LIENS",   
                   argsApi = list(q = "siretEtablissementPredecesseur:31300257800042"))
telechargerDonnees("SIRENE_SIREN_NONDIFF", 
                   argsApi = list(q = "dateDernierTraitementUniteLegale:2019-04-15"))
telechargerDonnees("SIRENE_SIRET_NONDIFF", argsApi = list(q = "siren:480419449"))
} # }
```

--------------------------------

### consulter(donnees, date = NULL, url_only = FALSE)

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/consulter.html

Opens the INSEE data description page for the specified dataset in the default browser, or returns the URL if url_only is TRUE. The date parameter allows selecting a specific vintage.

```APIDOC
## consulter(donnees, date = NULL, url_only = FALSE)

### Description
Opens the INSEE data description page for the specified dataset in the default browser, or returns the URL if url_only is TRUE.

### Usage
```r
consulter(donnees, date = NULL, url_only = FALSE)
```

### Arguments
- **donnees** (character) - Required - The name of the dataset whose description page is to be consulted. The full description of the data associated with this name is available in the table (liste_donnees).
- **date** (character) - Optional - The vintage of the data if necessary. Can be in format YYYY or DD/MM/YYYY; in the latter case, the first day of the reference period is used. Specifying "dernier" automatically selects the most recent vintage.
- **url_only** (logical) - Optional - TRUE to only retrieve the URL of the page without opening the browser.

### Value
By default, the function opens the link in the browser. It also invisibly returns the link to the web page.

### Examples
```r
consulter(donnees = "BPE_ENS")
consulter("RP_LOGEMENT", date = "2016")
# To only get the URL of the page
consulter("RP_LOGEMENT", date = "2016", url_only = TRUE)
#> [1] "https://www.insee.fr/fr/statistiques/4229099"
```
```

--------------------------------

### Download and plot first names data with Melodi

Source: https://inseefrlab.github.io/DoReMIFaSol/index.html

Downloads the DS_PRENOMS dataset via Melodi, filters for female births of Sophie and Claire in France, and plots the evolution over time.

```r
library(doremifasol)
library(tidyverse)
library(ggplot2)

prenoms <- telechargerDonnees("DS_PRENOMS") |> 
  filter(PRENOM %in% c("SOPHIE", "CLAIRE") & SEX == 2 & YOB != "XXXX" & GEO == "F") |> 
  mutate(annais = as.numeric(YOB))

ggplot(prenoms, aes(x = annais, y = OBS_VALUE, color = PRENOM)) +
  geom_line(linewidth = 1) +
  labs(title = "Évolution des prénoms Claire et Sophie en France",
       x = "Année",
       y = "Nombre de naissances",
       color = "Prénom") +
  theme_minimal()
```

--------------------------------

### Set INSEE API token in .Renviron

Source: https://inseefrlab.github.io/DoReMIFaSol/index.html

Sets the INSEE API token as an environment variable in the .Renviron file, replacing xxxxxxxx with the actual token.

```R
INSEE_API_TOKEN='xxxxxxxx'
```

--------------------------------

### Download Filosofi commune-level data

Source: https://inseefrlab.github.io/DoReMIFaSol/index.html

Downloads the Filosofi income and poverty indicators at the commune level for all households for 2017.

```r
donnees_filosofi <- telechargerDonnees("FILOSOFI_DISP_COM_ENS", date = 2017)
```

--------------------------------

### Download census housing data with selected columns

Source: https://inseefrlab.github.io/DoReMIFaSol/index.html

Downloads the 2016 population census housing data, selecting only the specified columns to reduce memory usage.

```r
donnees_rp <- telechargerDonnees("RP_LOGEMENT", date = 2016, vars = c("COMMUNE", "IPONDL", "CATL"))
```

--------------------------------

### telechargerDonnees

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/telechargerDonnees.html

Documentation de la fonction R telechargerDonnees pour télécharger des données depuis le site de l'Insee.

```APIDOC
## telechargerDonnees

### Description
Télécharge des données disponibles sur le site de l'Insee, sous format csv, xls ou xlsx. La fonction permet de récupérer des données brutes dans un data.frame, avec la possibilité de spécifier un millésime, un dossier de téléchargement, des paramètres API pour les données REST, et de sélectionner des variables pour les fichiers volumineux.

### Usage
```r
telechargerDonnees(
  donnees,
  date = NULL,
  telDir = getOption("doremifasol.telDir"),
  argsApi = NULL,
  vars = NULL,
  force = FALSE,
  ...
)
```

### Arguments
- **donnees** (character) - Requis - Le nom des données à télécharger, tel que référencé dans la table `liste_donnees`.
- **date** (character) - Optionnel - Le millésime des données, au format YYYY ou DD/MM/YYYY (dans ce cas, le premier jour de la période de référence est utilisé). Spécifier `"dernier"` sélectionne automatiquement le millésime le plus récent.
- **telDir** (character) - Optionnel - Le dossier dans lequel les données brutes sont téléchargées. Par défaut, la valeur définie par `options(doremifasol.telDir = ...)`. Si non défini, un dossier temporaire de cache est utilisé.
- **argsApi** (list) - Optionnel - Paramètres spécifiques à l'API REST utilisée, pour collecter l'information désirée.
- **vars** (character vector) - Optionnel - Vecteur de variables à importer, utile pour les données massives difficiles à charger en mémoire.
- **force** (logical) - Optionnel - Force le téléchargement même si le fichier a déjà été téléchargé (et est identique).
- **...** - Optionnel - Paramètres additionnels relatifs à l'importation des données.

### Value
- Un data.frame contenant les données téléchargées sur le site de l'Insee.
- Une liste de data.frames si recherche de Siren ou Siret via l'API.

### Details
La fonction télécharge les données disponibles sur le site de l'Insee sous format csv, xls ou xlsx. Pour les données volumineuses (comme le Recensement de Population ou SIRENE), l'utilisateur peut spécifier les variables à charger en mémoire via `vars`. Pour les gros fichiers zip (repérés par `big_zip = TRUE` dans les métadonnées), la fonction utilise `unzip` avec le paramètre `unzip = "unzip"` ; la commande unzip doit être installée sur le poste de l'utilisateur (sur Windows, renseigner le chemin dans la variable d'environnement %PATH%).

### Examples
```r
if (FALSE) { # \dontrun{

# fichiers sur insee.fr
bpe_ens_2019 <- telechargerDonnees(donnees = "BPE_ENS")
rp_log <- telechargerDonnees("RP_LOGEMENT", date = "2016", vars = c("COMMUNE", "IPONDL", "CATL"))

# utilisation de l'API Sirene
telechargerDonnees("SIRENE_SIREN",         
                   argsApi = list(q = "dateCreationUniteLegale:2021-03-01", nombre = 100))
telechargerDonnees("SIRENE_SIRET",         
                   argsApi = list(q = "codeCommuneEtablissement:92046 
                                       AND categorieJuridiqueUniteLegale:9220"))
telechargerDonnees("SIRENE_SIRET_LIENS",   
                   argsApi = list(q = "siretEtablissementPredecesseur:31300257800042"))
telechargerDonnees("SIRENE_SIREN_NONDIFF", 
                   argsApi = list(q = "dateDernierTraitementUniteLegale:2019-04-15"))
telechargerDonnees("SIRENE_SIRET_NONDIFF", argsApi = list(q = "siren:480419449"))
} # }
```
```

--------------------------------

### telechargerFichier(donnees, date, telDir, argsApi, force)

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/telechargerFichier.html

Télécharge un fichier de données depuis le site de l'Insee ou interroge une API REST. Les données disponibles sont identifiées par leur nom court dans la table liste_donnees.

```APIDOC
## telechargerFichier(donnees, date, telDir, argsApi, force)

### Description
Télécharge un fichier de données (csv, xls, xlsx) depuis le site de l'Insee ou interroge une API REST de manière expérimentale. Les données disponibles sont identifiées par leur nom court dans la table `liste_donnees`.

### Usage
```r
telechargerFichier(
  donnees,
  date = NULL,
  telDir = getOption("doremifasol.telDir"),
  argsApi = NULL,
  force = FALSE
)
```

### Arguments
- **donnees** (character) - Requis - Le nom court des données à télécharger. Insensible à la casse. La description complète figure dans la table `liste_donnees`.
- **date** (character) - Optionnel - Le millésime des données. Format YYYY ou DD/MM/YYYY (dans ce cas, premier jour de la période de référence). Spécifier `"dernier"` sélectionne le millésime le plus récent.
- **telDir** (character) - Optionnel - Dossier de téléchargement des données brutes. Par défaut, valeur de `options(doremifasol.telDir = ...)` ou un dossier temporaire de cache.
- **argsApi** (list) - Optionnel - Paramètres spécifiques à l'API REST utilisée pour collecter l'information désirée.
- **force** (logical) - Optionnel - Forcer le téléchargement même si le fichier a déjà été téléchargé (et est identique).

### Value
Une liste contenant le résultat du téléchargement et les informations pour l'importation des données en R (de manière invisible).

### Details
La fonction télécharge les données disponibles sur le site de l'Insee sous format csv, xls ou xlsx. Elle permet également, de manière expérimentale, de requêter certaines API REST de l'Insee ; ces services peuvent être repérés dans la table `liste_donnees` grâce à la variable `api_rest`.

### Examples
```r
if (FALSE) { # \dontrun{
telechargerFichier(donnees = "BPE_ENS")

telechargerFichier("RP_LOGEMENT", date = "2016")
} # }
```
```

--------------------------------

### sirets_successeurs(sirets, ...)

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/sirets_successeurs.html

Documentation de la fonction R `sirets_successeurs` qui télécharge les successeurs d'une liste d'établissements via l'API Sirene.

```APIDOC
## `sirets_successeurs(sirets, ...)`

### Description
Télécharge sur l'API Sirene l'ensemble des successeurs d'une liste d'établissements.

### Usage
```r
sirets_successeurs(sirets, ...)
```

### Arguments
- **sirets** (character vector) - Required - Établissements pour lesquels rechercher les successeurs (un vecteur caractère de numéros SIRET).
- **...** - Optional - Paramètres additionnels de la fonction `telechargerDonnees`.

### Value
Un data.frame agrégeant les résultats pour chaque siret (vide si aucun des établissements n'a de successeur).

### Details
Cette fonction appelle `telechargerDonnees` pour chacun des établissements passés en paramètre (de manière optimisée). Les données téléchargées au format "json" sont enregistrées dans un dossier temporaire.

### Authentification API Sirene
Comme toutes les fonctions reposant sur l'API Sirene, cette fonction nécessite une clé d'application et un secret associé pour pouvoir générer un jeton d'accès. Ces informations sont à passer sous forme de variables d'environnement. Renseigner pour cela `INSEE_API_TOKEN` dans un fichier de configuration `.Renviron`. Consulter cette page pour de l'aide sur comment obtenir de tels identifiants.

### Examples
```r
if (FALSE) { # \dontrun{

sirets_successeurs(c("30070230500040", "30137492200120", "30082187300019"))
} # }
```
```

--------------------------------

### Download ESTEL data with telechargerDonnees

Source: https://inseefrlab.github.io/DoReMIFaSol/index.html

Downloads localized employment estimates (ESTEL) for 2018 using the doremifasol package.

```R
donnees_estel <- telechargerDonnees("ESTEL_T201", date = 2018)
```

--------------------------------

### chargerDonnees(telechargementFichier, vars = NULL, ...)

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/chargerDonnees.html

Loads data downloaded by telechargerFichier into R as a data.frame (or list for API data). Allows selective variable import to manage memory usage.

```APIDOC
## chargerDonnees(telechargementFichier, vars = NULL, ...)

### Description
Loads data downloaded by `telechargerFichier` into R. Returns a data.frame (or list for API data).

### Usage
```r
chargerDonnees(telechargementFichier, vars = NULL, ...)
```

### Arguments
- **telechargementFichier** (list) - Required - A list containing all necessary information for loading data, created by `telechargerFichier`.
- **vars** (vector) - Optional - A vector of variables to import, to use computational resources sparingly. Default NULL loads all variables.
- **...** - Optional - Additional parameters for data import.

### Value
A data.frame containing the downloaded data (except for API data, which are usually lists containing data.frame objects).

### Details
Data are generally of reasonable size, but some (e.g., Recensement de Population, SIRENE) are very large. Users can select variables to load only those of interest.

### Examples
```r
if (FALSE) { # \dontrun{
dl_bpe <- telechargerFichier(donnees = "BPE_ENS")
bpe <- chargerDonnees(dl_bpe)
} # }
```
```

--------------------------------

### Signature de la fonction consulter()

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/consulter.html

Signature de la fonction R `consulter()` avec ses arguments `donnees`, `date` et `url_only`. Utilisée pour ouvrir la page descriptive des données sur insee.fr.

```r
consulter(donnees, date = NULL, url_only = FALSE)
```

--------------------------------

### millesimesDisponibles(donnees)

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/millesimesDisponibles.html

Lists the different vintages (millésimes) available for a given data source on the INSEE website. The function accepts the short name of the data source and returns a character vector of available vintages.

```APIDOC
## millesimesDisponibles(donnees)

### Description
Lists the different vintages (millésimes) available for a given data source on the INSEE website.

### Usage
```r
millesimesDisponibles(donnees)
```

### Arguments
- **donnees** (character) - Required - The short name of the data to download from the INSEE website. The full description of the data associated with this name is available in the `liste_donnees` table. Case insensitive.

### Value
A character vector containing all available vintages for the given data source.

### Examples
```r
millesimesDisponibles("RP_LOGEMENT")
#>  [1] "2010" "2011" "2012" "2013" "2014" "2015" "2016" "2017" "2018" "2019"
#> [11] "2020" "2021"
```
```

--------------------------------

### Query Sirene API with telechargerDonnees

Source: https://inseefrlab.github.io/DoReMIFaSol/index.html

Queries the Sirene REST API to retrieve establishments linked to legal units created on 2020-01-01. Requires a configured API access and the INSEE_API_TOKEN environment variable. Returns a list of six data.frames.

```R
etablissements <- telechargerDonnees("SIRENE_SIRET", 
                                     argsApi = list(q = "dateCreationUniteLegale:2020-01-01"))
```

--------------------------------

### telechargerFichier function signature

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/telechargerFichier.html

Signature of the telechargerFichier function. Arguments: donnees (short name of the data, case-insensitive), date (optional vintage, YYYY or DD/MM/YYYY, or "dernier" for the most recent), telDir (download directory, defaults to options(doremifasol.telDir) or a temporary cache), argsApi (optional API-specific parameters), force (force download even if the file already exists).

```r
telechargerFichier(
  donnees,
  date = NULL,
  telDir = getOption("doremifasol.telDir"),
  argsApi = NULL,
  force = FALSE
)
```

--------------------------------

### millesimesDisponibles usage

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/millesimesDisponibles.html

Usage of the function to list available vintages for a given data source. The argument 'donnees' is the short name of the data to download from the Insee website, case-insensitive, and its full description is in the 'liste_donnees' table.

```r
millesimesDisponibles(donnees)
```

--------------------------------

### Signature de la fonction telechargerDonnees

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/telechargerDonnees.html

Signature de la fonction R `telechargerDonnees` avec ses paramètres : `donnees`, `date`, `telDir`, `argsApi`, `vars`, `force`, et `...`.

```R
telechargerDonnees(
  donnees,
  date = NULL,
  telDir = getOption("doremifasol.telDir"),
  argsApi = NULL,
  vars = NULL,
  force = FALSE,
  ...
)
```

--------------------------------

### donnees_dispo

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/donnees_dispo.html

Displays an interactive table of available datasets. Users can search and filter the table. The function accepts an initial search term, the number of rows to display, and the position of column filters.

```APIDOC
## donnees_dispo

### Description
Displays an interactive table of available datasets. Users can search and filter the table. The function accepts an initial search term, the number of rows to display, and the position of column filters.

### Usage
```r
donnees_dispo(
  recherche_init = NULL,
  entrees = 10,
  pos_filtre = c("haut", "bas", "aucun"),
  ...
)
```

### Arguments
- **recherche_init** (character) - Optional - Initial search term to filter the table columns. Case-insensitive. Can be modified interactively.
- **entrees** (numeric) - Optional - Number of rows displayed at launch. Default is 10. Can be modified interactively.
- **pos_filtre** (character) - Optional - Position of column-specific filters: "haut" (default), "bas", or "aucun".
- **...** - Additional arguments passed to `DT::datatable`.

### Examples
```r
donnees_dispo()
donnees_dispo("commune")
```
```

--------------------------------

### Function signature: donnees_dispo

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/donnees_dispo.html

Shows the usage of the donnees_dispo function with its parameters: recherche_init (initial search term, case-insensitive), entrees (number of rows displayed, default 10), pos_filtre (filter position: 'haut' default, 'bas', or 'aucun'), and additional arguments passed to DT::datatable.

```R
donnees_dispo(
  recherche_init = NULL,
  entrees = 10,
  pos_filtre = c("haut", "bas", "aucun"),
  ...
)
```

--------------------------------

### sirets_successeurs function signature

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/sirets_successeurs.html

Function signature for retrieving successors of a list of establishments from the Sirene API. The `sirets` argument is a character vector of SIRET numbers, and `...` passes additional parameters to `telechargerDonnees`.

```r
sirets_successeurs(sirets, ...)
```

--------------------------------

### chargerDonnees function signature

Source: https://inseefrlab.github.io/DoReMIFaSol/reference/chargerDonnees.html

Signature of the chargerDonnees function. It takes a list created by telechargerFichier, an optional vector of variables to import, and additional import parameters.

```r
chargerDonnees(telechargementFichier, vars = NULL, ...)
```
Tokens:
Raw