relecture globale, vignette range, et suppression get_code_list (pas utile)

cbobinec · cbobinec · commit 5a146c6453cf · 2026-02-05T17:44:08.000+01:00
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -3,7 +3,7 @@ Title: Retrieve Data from the Insee Melodi APIs
 Version: 1.0.0
 Authors@R: c(
     person("Cédric", "Bobinec", email = "cedric.bobinec@insee.fr", role = c("aut", "cre")),
-    person("Christophe", "Goudeau", role = "ctb", email = "christophe.goudeau@insee.fr"),
+    person("Christophe", "Goudeau", role = "aut", email = "christophe.goudeau@insee.fr"),
     person(family = "Institut national de la statistique et des études économiques", role = "cph")
   )
 Description: A wrapper for the Insee Melodi APIs that returns data frames and metadata.
diff --git a/NAMESPACE b/NAMESPACE
@@ -3,7 +3,6 @@
 export("%>%")
 export(get_all_data)
 export(get_catalog)
-export(get_code_list)
 export(get_data)
 export(get_file)
 export(get_local_data)
diff --git a/NEWS.md b/NEWS.md
@@ -1,8 +1,6 @@
 # melodi 1.0.0
 - Relèvement du seuil de `get_data` à **100 000** lignes (amélioration de l'API Melodi)
-- Nouvelle fonction `get_code_list` permettant de récupérer simplement codes et libellés d'une liste de codes
-- Centralisation en **options** des paramètres techniques d'appel à l'API, 
-plutôt qu'en paramètre ou caché dans les fonctions
+- Centralisation en **options** des paramètres techniques d'appel à l'API, plutôt qu'en paramètre (ou caché) dans les fonctions
   - En tant qu'utilisateur, si besoin de changer un paramètre, 
   simplement lancer : `options(rmelodi.base_url_api = "https://...")`
 - Relectures diverses de documentation et du code (styler)
diff --git a/R/get_code_list.R b/R/get_code_list.R
diff --git a/R/globals.R b/R/globals.R
@@ -11,8 +11,6 @@ globalVariables(
     # get_data
     "value", "GEO",
     # get_range_geo
-    "GEO_REF", "GEO_OBJECT", "GEO_LABEL",
-    # get_code_list
-    "label", "code", "label_langue"
+    "GEO_REF", "GEO_OBJECT", "GEO_LABEL"
   )
 )
diff --git a/R/zzz.R b/R/zzz.R
@@ -2,9 +2,9 @@
   options(
     # Beginning of API URL (change only for developpement/internal use)
     rmelodi.base_url_api = "https://api.insee.fr/melodi",
-    # Maximum number of lines allowed by Melodi API
+    # Maximum maxResult allowed by Melodi API (change only if API improvement)
     rmelodi.max_result_api = 100000,
-    # Define user agent sent in headers with every requests (example : 'RMelodi/1.0.0')
+    # Define user agent sent in headers with every requests (default : 'RMelodi/1.0.0')
     rmelodi.req_user_agent = glue::glue("RMelodi/{utils::packageVersion('melodi')}")
   )
 }
diff --git a/README.md b/README.md
@@ -17,14 +17,14 @@ Installer la dernière version stable depuis github :
 remotes::install_github("InseeFrLab/melodi", build_vignettes = TRUE)
 ```
 
-(en environnement sans accès à github.com) télécharger la dernière "Release" disponible puis :
+(pour les agents Insee uniquement) installer la dernière version stable :
 ```R
-install.packages("~/Downloads/melodi-1.0.0.tar.gz")
+install.packages("melodi", repos = "https://nexus.insee.fr/repository/r-public/")
 ```
 
-(pour les agents Insee uniquement) installer la dernière version stable :
+(en environnement sans accès à github.com) télécharger la dernière "Release" disponible puis :
 ```R
-install.packages("melodi", repos = "https://nexus.insee.fr/repository/r-public/")
+install.packages("~/Downloads/melodi-1.0.0.tar.gz")
 ```
 
 ## Exemples
diff --git a/dev/dev_history.R b/dev/dev_history.R
@@ -34,7 +34,7 @@ devtools::check(
 pkgdown::build_site()
 
 # Creer une fonction ------------------------------------------------------
-#  Pour chaque fonction du package :
+# Pour chaque fonction du package :
 usethis::use_r("get_local_data")
 usethis::use_test("get_local_data")
 # écrire le code de la fonction
diff --git a/man/get_code_list.Rd b/man/get_code_list.Rd
diff --git a/tests/testthat/test-get_code_list.R b/tests/testthat/test-get_code_list.R
diff --git a/vignettes/C-range.Rmd b/vignettes/C-range.Rmd
@@ -0,0 +1,56 @@
+---
+title: "Travailler avec les libellés (range)"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{Travailler avec les libellés (range)}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+```{r setup, include = FALSE}
+library(melodi)
+library(dplyr)
+```
+
+# Travailler avec les libellés : la range
+
+## Cas général : get_range
+
+A chaque jeu de données est associée une "range", c'est à dire l'ensemble des codes et libellés présents dans le jeu de données.
+Ainsi, récupérer la range d'un jeu de données permet de récupérer les libellés associés aux codes du jeu de données.
+
+```{r get_range, eval = FALSE}
+data <- get_all_data("DS_POPULATIONS_REFERENCE")
+range <- get_range("DS_POPULATIONS_REFERENCE")
+
+# Récupérons par exemples les libellés des codes de "POPREF_MEASURE" : 
+# "Population municipale", "Population totale", etc. 
+data |> 
+  left_join(
+    y = range,
+    by = join_by(POPREF_MEASURE == MOD)
+  )
+# la variable supplémentaire MOD_LABEL contient ainsi le libellé de la mesure
+```
+
+## La géographie : get_range_geo
+
+L'usage le plus courant consiste à récupérer les libellés des codes géographiques. 
+
+Exemple : "Nantes" pour la commune (GEO_OBJECT='COM') dont le code GEO est '44109'.
+
+Pour cela, une fonction dédiée a été créée, permettant d'obtenir codes et libellés de tous les territoires du jeu de données passé en paramètre : `get_range_geo`
+
+```{r get_range_geo, eval = FALSE}
+get_range_geo("DS_POPULATIONS_REFERENCE")
+# GEO_LABEL contient le libellé associé aux codes GEO et GEO_OBJECT identifiant
+# un territoire dans le DS concerné
+```
+
diff --git a/vignettes/D-usage_backoffice.Rmd b/vignettes/D-usage_backoffice.Rmd
@@ -1,8 +1,8 @@
 ---
-title: "Usages internes Insee"
+title: "Autres usages"
 output: rmarkdown::html_vignette
 vignette: >
-  %\VignetteIndexEntry{Autres usages catalogue}
+  %\VignetteIndexEntry{Autres usages}
   %\VignetteEngine{knitr::rmarkdown}
   %\VignetteEncoding{UTF-8}
 ---
@@ -65,15 +65,14 @@ fic_xlsx1 <- get_file(
 
 # Travailler sur un autre environnement Melodi
 
-Le package dispose d'une *option* `rmelodi.base_url_api` permettant de travailler dans un autre environnement que Melodi en production, en spécifiant l'adresse de l'API Melodi à utiliser.
+Le package dispose d'une *option* `rmelodi.base_url_api` permettant de travailler dans un autre environnement que Melodi en production : surcharger sa valeur permet de travailler dans un autre environnement que la production, en fournissant l'URL de l'API à utiliser. Tous les appels de fonction du package se feront alors sur cet autre environnement.
 
-Pour cela fournir l'URL de base de l'API de l'environnement à utiliser. 
 S'il s'agit d'environnements internes, penser au besoin à désactiver le proxy pour l'URL en question.
 
 ```{r interne, eval = FALSE}
 Sys.setenv(no_proxy = "autre_url_api_melodi.fr")
 
 options(rmelodi.base_url_api = "https://autre_url_api_melodi.fr")
 
-get_catalog()
+get_catalog() # <- La fonction appelle https://autre_url_api_melodi.fr/catalog/all
 ```

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ Title: Retrieve Data from the Insee Melodi APIs`
`3`	`3`	`Version: 1.0.0`
`4`	`4`	`Authors@R: c(`
`5`	`5`	`person("Cédric", "Bobinec", email = "cedric.bobinec@insee.fr", role = c("aut", "cre")),`
`6`		`- person("Christophe", "Goudeau", role = "ctb", email = "christophe.goudeau@insee.fr"),`
	`6`	`+ person("Christophe", "Goudeau", role = "aut", email = "christophe.goudeau@insee.fr"),`
`7`	`7`	`person(family = "Institut national de la statistique et des études économiques", role = "cph")`
`8`	`8`	`)`
`9`	`9`	`Description: A wrapper for the Insee Melodi APIs that returns data frames and metadata.`
Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,6 @@ globalVariables(`
`11`	`11`	`# get_data`
`12`	`12`	`"value", "GEO",`
`13`	`13`	`# get_range_geo`
`14`		`- "GEO_REF", "GEO_OBJECT", "GEO_LABEL",`
`15`		`- # get_code_list`
`16`		`- "label", "code", "label_langue"`
	`14`	`+ "GEO_REF", "GEO_OBJECT", "GEO_LABEL"`
`17`	`15`	`)`
`18`	`16`	`)`
Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,9 @@`
`2`	`2`	`options(`
`3`	`3`	`# Beginning of API URL (change only for developpement/internal use)`
`4`	`4`	`rmelodi.base_url_api = "https://api.insee.fr/melodi",`
`5`		`- # Maximum number of lines allowed by Melodi API`
	`5`	`+ # Maximum maxResult allowed by Melodi API (change only if API improvement)`
`6`	`6`	`rmelodi.max_result_api = 100000,`
`7`		`- # Define user agent sent in headers with every requests (example : 'RMelodi/1.0.0')`
	`7`	`+ # Define user agent sent in headers with every requests (default : 'RMelodi/1.0.0')`
`8`	`8`	`rmelodi.req_user_agent = glue::glue("RMelodi/{utils::packageVersion('melodi')}")`
`9`	`9`	`)`
`10`	`10`	`}`