Skip to content
Snippets Groups Projects
Commit eae4b74a authored by ronan.vignard's avatar ronan.vignard
Browse files

Correction du problème sur les exemples des fonctions add_code

parent 676939cb
No related branches found
No related tags found
9 merge requests!32Passage en version 1.2.2,!31Mise à jour des vignettes suite à l'intégration du millésime 2024,!30Mise à jour des procédures en lien avec le millésime 2024 + Actualisation du README,!29Correction du lien vers l'image pour le site pkgdown,!28Passage en version 1.2.1,!27Finalisation de l'actualisation de la nouvelle logique métier,!26Création d'une table unique des prélèvements et analyses,!24Passage en version 1.2.0,!23Correctifs + documentation
......@@ -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
......
......@@ -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
......
......@@ -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)
```
......
......@@ -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)
```
......
......@@ -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)
}
......@@ -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)
}
......@@ -2,7 +2,7 @@
title: "Création des tables et des séquences"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{Création des tables et desquences}
%\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)
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment