README.md

datalibaba

{datalibaba} est un ensemble de fonctions visant à faciliter l’alimentation du serveur de données du DREAL Pays de la Loire.

Installation

remotes::install_gitlab('dreal-datalab/datalibaba')

Example

library(datalibaba)

Vérifier la configuration de son poste

La fonction permet de s’assurer que les variables systèmes sont bien activées.

check_server_renviron()

Se connecter

con sera utilisé ensuite sur l’ensemble des autres fonctions pour dialoguer avec le serveur de base de données.

con <- connect_to_db(db="datamart", user="does")

Lister les schémas

list_schemas(con)

Lister les tables d’un schéma

Ici on liste les table du schéma public

list_tables(con, "public")

Charger une table

Un dataframe de votre environnement peut être chargée dans le serveur de base de données

post_data(con, data = head(iris), schema = "public", table = "iris").

La fonction poster_data() se veut plus complète :

• elle ouvre et ferme la connexion au SGBD,
• elle gère les dataframes spatiaux, les variables temporelles et les facteurs,
• elle adapte le dataset posté pour respecter quelques contraintes d’administration du SGBD (normalisation du nom des variables, ajout de clé primaire, et pour les tables spatiales : ajout d’index spatial, déclaration du CRS et du nb de dimensions de la géométrie)
• poste quelques métadonnées en commentaire de la table (auteur du chargement et sa date).

Le schéma spécifié en argument est créé s’il n’existe pas.

poster_data(data = iris, table = "test_iris", schema = "zonages_habitat", db = "production", user = "does", overwrite = TRUE)

Télécharger une table

Une table du serveur de base de données peut être téléchargée en dataframe.

db_iris <- get_data(con, schema = "public", table = "iris")

La fonction importer_data() se veut plus complète :

• elle ouvre et ferme la connexion au SGBD,
• elle gère les dataframes spatiaux, les variables temporelles et les facteurs,
• et ‘déstandardise’ les noms de champs si le dataset a été posté avec poster_data(),

de manière à retrouver le dataframe dans l’état précis où il était avant son versement au SGBD.

db_iris <- importer_data(table = "test_iris", schema = "zonages_habitat", db = "production", user = "does", overwrite = TRUE)

Poster des métadonnées en commentaires

On peut commenter les tables chargées sur le SGBD depuis RStudio :

commenter_table(comment = "Je suis un commentaire important sur la table test_iris.", table = "test_iris", 
                schema = "public", db = "production", user = "does")

En dehors des informations spécifiées au niveau de l’argument comment, la fonction ajoute le nom de l’auteur et la date du commentaire.

Des fonctions existent également pour commenter un schéma : commenter_schema() ou un champ de table (= une variable ou un attribut) : commenter_champ().

Enfin la fonction post_dico_attr() permet de verser tout un dictionnaire d’attributs/dictionnaire des variables en commentaires de champ à partir d’un dataframe. Ce dataframe doit comprendre deux champs

le 1er pour le nom des variables, le second pour leur explicitation. Le nommage de ces deux champs n’a pas d’importance, leur ordre importe en revanche. Ce dataframe peut comprendre autant de lignes que d’attributs que l’on souhaite documenter.

dico_iris <- data.frame(VAR = names(iris), VAR_LIB = paste("ceci est le libellé descriptif de", names(iris)))
post_dico_attr(dico = dico_iris, table = "test_iris", schema = "zonages_habitat", db = "production", user = "does")