diff --git a/R/add_code_analyse.R b/R/add_code_analyse.R index 7fd63b333c2445841eae0fe946d05eefb66901d5..b60c7f84aae6bc9692fea027c581d92d0585947c 100644 --- a/R/add_code_analyse.R +++ b/R/add_code_analyse.R @@ -20,9 +20,17 @@ #' @importFrom datalibaba connect_to_db #' @export #' @examples +#' # Crée un dataframe fictif avec les colonnes nécessaires pour l'exemple +#' dataframe <- data.frame( +#' id_prelevement = 1:5, +#' autre_colonne = sample(letters, 5) +#' ) +#' # Définir une version pour l'exemple +#' version <- "v1" +#' #' # Utiliser la fonction add_code_analyse() avec la version souhaitée -#' nitrate_analyse_ars <- add_code_analyse( -#' nitrate_analyse_ars, version) +#' dataframe <- add_code_analyse( +#' dataframe, version) #' add_code_analyse <- function(dataframe, version) { # Établir une connexion à la base de données PostgreSQL diff --git a/R/add_code_prelevement.R b/R/add_code_prelevement.R index c16f077ae8cf944a9c8d22ebde70161134465146..b8b943f00d380738c102caf7bf84e3965b62a381 100644 --- a/R/add_code_prelevement.R +++ b/R/add_code_prelevement.R @@ -20,9 +20,17 @@ #' @importFrom datalibaba connect_to_db #' @export #' @examples +#' # Crée un dataframe fictif avec les colonnes nécessaires pour l'exemple +#' dataframe <- data.frame( +#' id_prelevement = 1:5, +#' autre_colonne = sample(letters, 5) +#' ) +#' # Définir une version pour l'exemple +#' version <- "v1" +#' #' # Utiliser la fonction add_code_prelevement() avec la version souhaitée -#' nitrate_data_analyse_ars <- add_code_prelevement( -#' nitrate_data_analyse_ars, version) +#' dataframe <- add_code_prelevement( +#' dataframe, version) #' add_code_prelevement <- function(dataframe, version) { # Établir une connexion à la base de données PostgreSQL diff --git a/dev/flat_create_tables_sequences.Rmd b/dev/flat_create_tables_sequences.Rmd index cf627980565414e194f39356b045dbdbe3720f4c..7681843bf3d617d9ee02fcc96e559bae4b4bfb67 100644 --- a/dev/flat_create_tables_sequences.Rmd +++ b/dev/flat_create_tables_sequences.Rmd @@ -288,10 +288,18 @@ add_code_prelevement <- function(dataframe, version) { La fonction est utilisée au moment d'importer les données des différentes sources dans la table `nitrates.nitrate_prelevement_version` : -```{r example_add_code_prelevement_ars, eval=FALSE} +```{r example_add_code_prelevement, eval=FALSE} +# Crée un dataframe fictif avec les colonnes nécessaires pour l'exemple +dataframe <- data.frame( + id_prelevement = 1:5, + autre_colonne = sample(letters, 5) +) +# Définir une version pour l'exemple +version <- "v1" + # Utiliser la fonction add_code_prelevement() avec la version souhaitée -nitrate_data_analyse_ars <- add_code_prelevement( - nitrate_data_analyse_ars, version) +dataframe <- add_code_prelevement( + dataframe, version) ``` @@ -349,10 +357,18 @@ add_code_analyse <- function(dataframe, version) { La fonction est utilisée au moment d'importer les données des différentes sources dans la table `nitrates.nitrate_analyse_version` : On ajoute un identifiant unique s'appuyant sur une séquence stockée en base : -```{r example_add_code_analyse_ars, eval=FALSE} +```{r example_add_code_analyse, eval=FALSE} +# Crée un dataframe fictif avec les colonnes nécessaires pour l'exemple +dataframe <- data.frame( + id_prelevement = 1:5, + autre_colonne = sample(letters, 5) +) +# Définir une version pour l'exemple +version <- "v1" + # Utiliser la fonction add_code_analyse() avec la version souhaitée -nitrate_analyse_ars <- add_code_analyse( - nitrate_analyse_ars, version) +dataframe <- add_code_analyse( + dataframe, version) ``` diff --git a/inst/rmarkdown/templates/creation-des-tables-et-des-sequences/skeleton/skeleton.Rmd b/inst/rmarkdown/templates/creation-des-tables-et-des-sequences/skeleton/skeleton.Rmd index cf627980565414e194f39356b045dbdbe3720f4c..7681843bf3d617d9ee02fcc96e559bae4b4bfb67 100644 --- a/inst/rmarkdown/templates/creation-des-tables-et-des-sequences/skeleton/skeleton.Rmd +++ b/inst/rmarkdown/templates/creation-des-tables-et-des-sequences/skeleton/skeleton.Rmd @@ -288,10 +288,18 @@ add_code_prelevement <- function(dataframe, version) { La fonction est utilisée au moment d'importer les données des différentes sources dans la table `nitrates.nitrate_prelevement_version` : -```{r example_add_code_prelevement_ars, eval=FALSE} +```{r example_add_code_prelevement, eval=FALSE} +# Crée un dataframe fictif avec les colonnes nécessaires pour l'exemple +dataframe <- data.frame( + id_prelevement = 1:5, + autre_colonne = sample(letters, 5) +) +# Définir une version pour l'exemple +version <- "v1" + # Utiliser la fonction add_code_prelevement() avec la version souhaitée -nitrate_data_analyse_ars <- add_code_prelevement( - nitrate_data_analyse_ars, version) +dataframe <- add_code_prelevement( + dataframe, version) ``` @@ -349,10 +357,18 @@ add_code_analyse <- function(dataframe, version) { La fonction est utilisée au moment d'importer les données des différentes sources dans la table `nitrates.nitrate_analyse_version` : On ajoute un identifiant unique s'appuyant sur une séquence stockée en base : -```{r example_add_code_analyse_ars, eval=FALSE} +```{r example_add_code_analyse, eval=FALSE} +# Crée un dataframe fictif avec les colonnes nécessaires pour l'exemple +dataframe <- data.frame( + id_prelevement = 1:5, + autre_colonne = sample(letters, 5) +) +# Définir une version pour l'exemple +version <- "v1" + # Utiliser la fonction add_code_analyse() avec la version souhaitée -nitrate_analyse_ars <- add_code_analyse( - nitrate_analyse_ars, version) +dataframe <- add_code_analyse( + dataframe, version) ``` diff --git a/man/add_code_analyse.Rd b/man/add_code_analyse.Rd index 0b08cb92527db885cddcb653990e5b3991904cbf..0ec07e08008a0ecca715ae5e748665152afca6f1 100644 --- a/man/add_code_analyse.Rd +++ b/man/add_code_analyse.Rd @@ -23,8 +23,16 @@ au dataframe en utilisant une séquence PostgreSQL dynamique. La séquence est construite en fonction du paramètre \code{version} fourni. } \examples{ +# Crée un dataframe fictif avec les colonnes nécessaires pour l'exemple +dataframe <- data.frame( + id_prelevement = 1:5, + autre_colonne = sample(letters, 5) +) +# Définir une version pour l'exemple +version <- "v1" + # Utiliser la fonction add_code_analyse() avec la version souhaitée -nitrate_analyse_ars <- add_code_analyse( - nitrate_analyse_ars, version) +dataframe <- add_code_analyse( + dataframe, version) } diff --git a/man/add_code_prelevement.Rd b/man/add_code_prelevement.Rd index 3de9b27fa9814b815ffe7d5894d92fc504322ee6..1c47da57d03766474b6eec04b9aa08aeb498eac4 100644 --- a/man/add_code_prelevement.Rd +++ b/man/add_code_prelevement.Rd @@ -23,8 +23,16 @@ au dataframe en utilisant une séquence PostgreSQL dynamique. La séquence est construite en fonction du paramètre \code{version} fourni. } \examples{ +# Crée un dataframe fictif avec les colonnes nécessaires pour l'exemple +dataframe <- data.frame( + id_prelevement = 1:5, + autre_colonne = sample(letters, 5) +) +# Définir une version pour l'exemple +version <- "v1" + # Utiliser la fonction add_code_prelevement() avec la version souhaitée -nitrate_data_analyse_ars <- add_code_prelevement( - nitrate_data_analyse_ars, version) +dataframe <- add_code_prelevement( + dataframe, version) } diff --git a/vignettes/creation-des-tables-et-des-sequences.Rmd b/vignettes/creation-des-tables-et-des-sequences.Rmd index 71d9188a7b15dcfea4d6331a51b3b633fab43f52..7ca00a3aa044f629a707453db997b2596ac2aa2c 100644 --- a/vignettes/creation-des-tables-et-des-sequences.Rmd +++ b/vignettes/creation-des-tables-et-des-sequences.Rmd @@ -2,7 +2,7 @@ title: "Création des tables et des séquences" output: rmarkdown::html_vignette vignette: > - %\VignetteIndexEntry{Création des tables et des séquences} + %\VignetteIndexEntry{creation-des-tables-et-des-sequences} %\VignetteEngine{knitr::rmarkdown} %\VignetteEncoding{UTF-8} --- @@ -14,18 +14,13 @@ knitr::opts_chunk$set( ) ``` -```{r} +```{r setup} library(data.nitrates) ``` <!-- WARNING - This vignette is generated by {fusen} from dev/flat_create_tables_sequences.Rmd: do not edit by hand --> - - - -```{r config} -#| eval: no - +```{r config, eval = FALSE} # Lire le fichier de configuration config <- yaml::read_yaml("config.yml") @@ -34,67 +29,73 @@ version <- config$version last_year <- config$last_year ``` - # Présentation Cette page contient les fonctions permettant : - de créer en base les tables `nitrates.nitrate_prelevement_version` et `nitrates.nitrate_analyse_version`, - d'incrémenter les séquences correspondantes au moment de l'import des données. + # Création des tables en base ## Création de la table des prélèvements et ajout des commentaires Création de la table `nitrates.nitrate_prelevement_version` : -```{r create_nitrate_prelevement_table_version} -#| eval: no +```{r create_nitrate_prelevement_table_version, eval = FALSE} # Création du script SQL avec la version choisie sql <- create_nitrate_prelevement_table(version, last_year) ``` - ## Création de la table des analyses et ajout des commentaires Création de la table `nitrates.nitrate_analyse_version` : -```{r create_nitrate_analyse_table} -#| eval: no +```{r create_nitrate_analyse_table, eval = FALSE} # Création du script SQL avec la version choisie sql <- create_nitrate_analyse_table(version, last_year) ``` - # Incrémentation des séquences ## Incrémentation de la table des prélèvements La fonction est utilisée au moment d'importer les données des différentes sources dans la table `nitrates.nitrate_prelevement_version` : -```{r example_add_code_prelevement_ars} -#| eval: no + +```{r example_add_code_prelevement, eval = FALSE} +# Crée un dataframe fictif avec les colonnes nécessaires pour l'exemple +dataframe <- data.frame( + id_prelevement = 1:5, + autre_colonne = sample(letters, 5) +) +# Définir une version pour l'exemple +version <- "v1" # Utiliser la fonction add_code_prelevement() avec la version souhaitée -nitrate_data_analyse_ars <- add_code_prelevement( - nitrate_data_analyse_ars, version) +dataframe <- add_code_prelevement( + dataframe, version) ``` - ## Incrémentation de la table des analyses La fonction est utilisée au moment d'importer les données des différentes sources dans la table `nitrates.nitrate_analyse_version` : On ajoute un identifiant unique s'appuyant sur une séquence stockée en base : -```{r example_add_code_analyse_ars} -#| eval: no + +```{r example_add_code_analyse, eval = FALSE} +# Crée un dataframe fictif avec les colonnes nécessaires pour l'exemple +dataframe <- data.frame( + id_prelevement = 1:5, + autre_colonne = sample(letters, 5) +) +# Définir une version pour l'exemple +version <- "v1" # Utiliser la fonction add_code_analyse() avec la version souhaitée -nitrate_analyse_ars <- add_code_analyse( - nitrate_analyse_ars, version) +dataframe <- add_code_analyse( + dataframe, version) ``` - - -