diff --git a/vignettes/ban_fr.Rmd b/vignettes/ban_fr.Rmd index a8b1ff3dc86b0dda92750468c43ac8b9854fad07..13cbb2ee74b008f3d5a9295190452e32373e1310 100644 --- a/vignettes/ban_fr.Rmd +++ b/vignettes/ban_fr.Rmd @@ -19,15 +19,17 @@ knitr::opts_chunk$set( # Description for BAN database -La base de donnée **BAN** (acronyme de base adresse nationale) est la référence pour les adresses en France, officiellement reconnue par l’administration française. Elle est produite et mise à jour par Etalab, un département de la direction interministérielle du numérique (DINUM) ainsi que l'Institut Géographique National (IGN) et l’agence nationale de la cohésion des territoires (ANCT). Elle est également mise à jour et implémentée grâce aux organismes partenaires (acteurs publics locaux) qui créé une Base d'Adresse Locale (BAL) dans un format standardisé qui vient alimenter la BAN. Elle est disponible à l'adresse suivante : https://adresse.data.gouv.fr/donnees-nationales , ainsi que des des éléments de description, qui ont servis à la rédaction de ce paragraphe. +La base de donnée **BAN** (acronyme de base adresse nationale) est la référence pour les adresses en France, officiellement reconnue par l’administration française. Elle est produite et mise à jour par Etalab, un département de la direction interministérielle du numérique (DINUM) ainsi que l'Institut Géographique National (IGN) et l’agence nationale de la cohésion des territoires (ANCT). Elle est également mise à jour et implémentée grâce aux organismes partenaires (acteurs publics locaux) à travers la création d'une Base d'Adresse Locale (BAL) dans un format standardisé qui vient alimenter la BAN. + +Elle est diffusée avec une licence ouverte Etalab à l'adresse suivante : https://adresse.data.gouv.fr/donnees-nationales La périodicité de la mise à jour de la **BAN** est quotidienne. -Les informations disponibles dans la **BAN** sont organisées sous forme de deux fichiers (adresses et lieux-dits) par département. +La couverture des données comprend la France entière (y compris les collectivités d’outremer). Les informations disponibles dans la **BAN** sont organisées sous forme de deux fichiers (adresses et lieux-dits) par département. Le format de données est de type csv, séparateur ";" et l'encodage UTF-8. -# floodam.data and BAN +# Manipulation de la BAN avec floodam.data floodam.data permet de gérer la maintenance d'une base de donnée locale, adaptée. Les fonctions clés utilisées sont : @@ -38,3 +40,57 @@ floodam.data permet de gérer la maintenance d'une base de donnée locale, adapt - analyser si une version de la ban adaptée est différente d'une autre - si c'est le cas alerter l'équipe sur Mattermost - supprimer la plus ancienne des versions + +## Téléchargement de la base de données BAN + +Pour cette tâche, **floodam.data** se sert de la fonction `download_ban()`. + +Il y a 1 source possible pour le téléchargement de la base de données : + +- https://adresse.data.gouv.fr/donnees-nationales + +La dernière source est un miroir de la première. + +La fonction `download_ban()` La fonction permet de télécharger la base de données, en premier lieu, à partir de la première adresse. Des sources alternatives peuvent être utilisées en fournissant des paramètres additionnels (voir aide de la fonction : http://www.floodam.org/floodam.data/reference/download_ban.html). + +```{r} +#| label: "download-ban" +#| eval: false +library(floodam.data) +destination = file.path("ban", "download") +download_ban(destination) +``` + + +## Traitement de la base de données BAN + +Pour cette tâche, **floodam.data** utilise la fonction `adapt_ban()`. + +Une fois telechargée, la base de données peut être traitée avec la fonction `adapt_ban()`. Cette fonction effectue plusieures transformations sur la base de données originale : + +1. Le système de référence des coordonnées (CRS) est vérifié. Si aucun n'est présent, le CRS **EPSG:4326** est défini par défaut. Si un autre CRS est fourni par le paramètre `projection`, la base de données est reprojetée pour correspondre au CRS fourni. +1. Les géométries sont vérifiées et rendues valides si nécessaire. +1. Un schéma pré-configuré (`floodam.data::scheme_ban`) est appliqué à la base de données afin de consolider les noms et types de variables. +1. La sortie est sauvegardée comme fichier *rds* dans le dossier fourni dans le paramètre `destination`. + + +### Schéma appliqué aux données + +Le schéma appliqué aux données est détaillé dans le tableau suivant : + +```{r} +#| label: "scheme-ban" +#| echo: false +# utils::data(scheme_ban, package = "floodam.data") +knitr::kable( + floodam.data::scheme_ban, + row.names = FALSE, + caption = "Schéma appliqué à la base de donnée BAN") +``` + + +## Analyse de la base de données BAN + +Pour cette tâche, **floodam.data** se sert de la fonction `analyse_ban()`. + +**→ A fournir une fois que la fonction sera finie** \ No newline at end of file