ajout check_server_renviron()

rajout de détail sur le readme

DESCRIPTION

@@ -15,10 +15,13 @@ Description: Interface de connexion a une base Posgres : lecture,
 License: GPL (>= 3)
 Imports: 
     attempt,
+    crayon,
     DBI,
+    fs,
     glue,
     odbc,
-    RPostgreSQL
+    RPostgreSQL,
+    usethis
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)

NAMESPACE

 # Generated by roxygen2: do not edit by hand
 
+export(check_server_renviron)
 export(connect_to_db)
 export(get_data)
 export(list_schemas)
@@ -14,5 +15,15 @@ importFrom(RPostgreSQL,postgresqlpqExec)
 importFrom(attempt,message_if)
 importFrom(attempt,stop_if)
 importFrom(attempt,stop_if_not)
+importFrom(crayon,bgCyan)
+importFrom(crayon,bold)
+importFrom(fs,path)
+importFrom(fs,path_expand)
+importFrom(fs,path_home_r)
 importFrom(glue,glue)
 importFrom(odbc,odbc)
+importFrom(usethis,proj_get)
+importFrom(usethis,ui_done)
+importFrom(usethis,ui_info)
+importFrom(usethis,ui_oops)
+importFrom(usethis,ui_todo)

NEWS.md

@@ -5,5 +5,6 @@
 - ajout de la fonction `list_tables()' : Liste les tables sur un schéma d'un connecteur.
 - ajout de la fonction `post_data()' : Chargement d'un dataset sur le serveur
 - ajout de la fonction `get_data()' : Import d'un dataset du serveur.
+- ajout de la fonction `check_server_renviron()` qui vérifie si les variables système sont bien activées via .Renviron.
 
 * Added a `NEWS.md` file to track changes to the package.

R/check_server_renviron.R

+#' @importFrom fs path_expand path_home_r path
+#' @importFrom usethis proj_get
+scoped_path_r <- function(scope = c("user", "project"), ..., envvar = NULL) {
+  scope <- match.arg(scope)
+  if (scope == "user" && !is.null(envvar)) {
+    env <- Sys.getenv(envvar, unset = "")
+    if (!identical(env, "")) {
+      return(fs::path_expand(env))
+    }
+  }
+  root <- switch(scope,
+                 user = fs::path_home_r(),
+                 project = usethis::proj_get()
+  )
+  fs::path(root, ...)
+}
+#' Vérifie si les variables système sont bien activées via .Renviron.
+#' @importFrom crayon bold bgCyan
+#' @importFrom glue glue
+#' @importFrom usethis ui_oops ui_info ui_todo ui_done
+#' @export
+check_server_renviron <- function() {
+  path <- scoped_path_r("user", ".Renviron", envvar = "R_ENVIRON_USER")
+  if (!file.exists(path)) {
+    usethis::ui_oops(glue::glue("{crayon::bold('.Renviron')} : le fichier {crayon::bgCyan$white(path)} n'existe pas"))
+  }
+  if (file.exists(path)) {
+    usethis::ui_info(glue::glue("v\u00e9rification de la configuration des variables syst\u00e8me \u00e0 l'adresse {crayon::bgCyan$white(path)}."))
+
+    if (Sys.getenv('server')=='') {
+      usethis::ui_todo(glue::glue("{crayon::bold('.Renviron')} : la variable {crayon::bold('server')} n'est pas d\u00e9finie."))
+    }
+    if (Sys.getenv('port')=='') {
+      usethis::ui_todo(glue::glue("{crayon::bold('.Renviron')} : la variable {crayon::bold('port')} n'est pas d\u00e9finie."))
+    }
+    if (Sys.getenv('user_does')=='') {
+      usethis::ui_todo(glue::glue("{crayon::bold('.Renviron')} : la variable {crayon::bold('user_does')} n'est pas d\u00e9finie."))
+    }
+    if (Sys.getenv('pwd_does')=='') {
+      usethis::ui_todo(glue::glue("{crayon::bold('.Renviron')} : la variable {crayon::bold('pwd_does')} n'est pas d\u00e9finie."))
+    }
+    if (Sys.getenv('server')!='') {
+      usethis::ui_done(glue::glue("{crayon::bold('.Renviron')} : la variable {crayon::bold('server')}  est d\u00e9finie avec la valeur {crayon::bold(Sys.getenv('server'))}"))
+    }
+    if (Sys.getenv('port')!='') {
+      usethis::ui_done(glue::glue("{crayon::bold('.Renviron')} : la variable {crayon::bold('port')} est d\u00e9finie avec la valeur {crayon::bold(Sys.getenv('port'))}"))
+    }
+    if (Sys.getenv('user_does')!='') {
+      usethis::ui_done(glue::glue("{crayon::bold('.Renviron')} : la variable {crayon::bold('user_does')} est d\u00e9finie avec la valeur {crayon::bold(Sys.getenv('user_does'))}"))
+    }
+    if (Sys.getenv('pwd_does')!='') {
+      usethis::ui_done(glue::glue("{crayon::bold('.Renviron')} : la variable {crayon::bold('pwd_does')} est d\u00e9finie avec la valeur {crayon::bold(Sys.getenv('pwd_does'))}"))
+    }
+  }
+}

README.Rmd

@@ -35,8 +35,18 @@ remotes::install_gitlab('dreal-datalab/datalibaba')
 library(datalibaba)
 ```
 
+### Vérifier la configuration de son poste
+
+La fonction permet de s'assurer que les variables systèmes sont bien activées.
+
+```{r, eval=FALSE}
+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.
+
 ```{r, eval=FALSE}
 con <- connect_to_db <- function(db="datamart",
                                 user="does"
@@ -49,7 +59,9 @@ con <- connect_to_db <- function(db="datamart",
 list_schemas(con)
 ```
 
-### Lister les tables du schéma public
+### Lister les tables d'un schéma
+
+Ici on liste les table du schéma public
 
 ```{r, eval=FALSE}
 list_tables(con,"public")
@@ -57,12 +69,16 @@ list_tables(con,"public")
 
 ### Charger une table
 
+Un dataframe de votre environnement peut être chargée dans le serveur de base de données
+
 ```{r, eval=FALSE}
 post_data(con,data = head(iris), schema = "public",table = "iris")
 ```
 
 ### Télécharger une table
 
+Une table du serveur de base de données peut être téléchargée en dataframe.
+
 ```{r, eval=FALSE}
 db_iris <- get_data(con,schema = "public",table = "iris")
 ```

README.md

@@ -21,8 +21,20 @@ remotes::install_gitlab('dreal-datalab/datalibaba')
 library(datalibaba)
 ```
 
+### Vérifier la configuration de son poste
+
+La fonction permet de s’assurer que les variables systèmes sont bien
+activées.
+
+``` r
+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.
+
 ``` r
 con <- connect_to_db <- function(db="datamart",
                                 user="does"
@@ -35,7 +47,9 @@ con <- connect_to_db <- function(db="datamart",
 list_schemas(con)
 ```
 
-### Lister les tables du schéma public
+### Lister les tables d’un schéma
+
+Ici on liste les table du schéma public
 
 ``` r
 list_tables(con,"public")
@@ -43,12 +57,18 @@ list_tables(con,"public")
 
 ### Charger une table
 
+Un dataframe de votre environnement peut être chargée dans le serveur de
+base de données
+
 ``` r
 post_data(con,data = head(iris), schema = "public",table = "iris")
 ```
 
 ### Télécharger une table
 
+Une table du serveur de base de données peut être téléchargée en
+dataframe.
+
 ``` r
 db_iris <- get_data(con,schema = "public",table = "iris")
 ```

dev_history.R

@@ -6,11 +6,12 @@ usethis::edit_file("dev_history.R")
 usethis::use_build_ignore('dev_history.R')
 usethis::use_gpl3_license()
 usethis::edit_file('DESCRIPTION')
-usethis::user_r("connect_to_db.R")
-usethis::user_r("list_schemas.R")
-usethis::user_r("list_tables.R")
-usethis::user_r("post_data.R")
-usethis::user_r("get_data.R")
+usethis::use_r("connect_to_db.R")
+usethis::use_r("list_schemas.R")
+usethis::use_r("list_tables.R")
+usethis::use_r("post_data.R")
+usethis::use_r("get_data.R")
+usethis::use_r("check_server_renviron")
 usethis::use_news_md()
 usethis::use_readme_rmd()
 usethis::use_logo("inst/figures/logo.png")

man/check_server_renviron.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/check_server_renviron.R
+\name{check_server_renviron}
+\alias{check_server_renviron}
+\title{vérifie si les variables système sont bien activées via .Renviron}
+\usage{
+check_server_renviron()
+}
+\description{
+vérifie si les variables système sont bien activées via .Renviron
+}