diff --git a/dev/flat_create_tables_sequences.Rmd b/dev/flat_create_tables_sequences.Rmd index fbfa5891178f41f3f67e02925dfe778d5fd3787d..cf627980565414e194f39356b045dbdbe3720f4c 100644 --- a/dev/flat_create_tables_sequences.Rmd +++ b/dev/flat_create_tables_sequences.Rmd @@ -27,6 +27,12 @@ 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 @@ -280,6 +286,15 @@ 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} +# Utiliser la fonction add_code_prelevement() avec la version souhaitée +nitrate_data_analyse_ars <- add_code_prelevement( + nitrate_data_analyse_ars, version) + +``` + ## Incrémentation de la table des analyses ```{r function-add_code_analyse, eval=FALSE} @@ -331,6 +346,16 @@ 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} +# Utiliser la fonction add_code_analyse() avec la version souhaitée +nitrate_analyse_ars <- add_code_analyse( + nitrate_analyse_ars, version) + +``` + ```{r development-skeleton-dir, eval=FALSE} # Créer de l'arborescence et des fichiers du template usethis::use_rmarkdown_template( 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 28c7dbf2bf50d08f79f928895a97c5978694751c..cf627980565414e194f39356b045dbdbe3720f4c 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 @@ -27,6 +27,12 @@ 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 @@ -280,6 +286,15 @@ 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} +# Utiliser la fonction add_code_prelevement() avec la version souhaitée +nitrate_data_analyse_ars <- add_code_prelevement( + nitrate_data_analyse_ars, version) + +``` + ## Incrémentation de la table des analyses ```{r function-add_code_analyse, eval=FALSE} @@ -331,7 +346,17 @@ add_code_analyse <- function(dataframe, version) { ``` -```{r development-skeleton, eval=FALSE} +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} +# Utiliser la fonction add_code_analyse() avec la version souhaitée +nitrate_analyse_ars <- add_code_analyse( + nitrate_analyse_ars, version) + +``` + +```{r development-skeleton-dir, eval=FALSE} # Créer de l'arborescence et des fichiers du template usethis::use_rmarkdown_template( template_name = "Cr\u00e9ation des tables et des s\u00e9quences", @@ -339,7 +364,9 @@ usethis::use_rmarkdown_template( template_description = "Cr\u00e9ation des tables et des s\u00e9quences", template_create_dir = TRUE ) +``` +```{r development-skeleton-copy, eval=FALSE} # Définir les chemins source et destination source_file <- "dev/flat_create_tables_sequences.Rmd" destination_dir <- "inst/rmarkdown/templates/creation-des-tables-et-des-sequences/skeleton" @@ -351,10 +378,8 @@ message("File copied and renamed successfully.") ``` - ```{r development-inflate, eval=FALSE} # Run but keep eval=FALSE to avoid infinite loop # Execute in the console directly fusen::inflate(flat_file = "dev/flat_create_tables_sequences.Rmd", vignette_name = "Cr\u00e9ation des tables et des s\u00e9quences") ``` - diff --git a/vignettes/creation-des-tables-et-des-sequences.Rmd b/vignettes/creation-des-tables-et-des-sequences.Rmd index c9498328ef147c7ef2f62ef9d118833ef406172d..71d9188a7b15dcfea4d6331a51b3b633fab43f52 100644 --- a/vignettes/creation-des-tables-et-des-sequences.Rmd +++ b/vignettes/creation-des-tables-et-des-sequences.Rmd @@ -35,6 +35,12 @@ 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 @@ -63,7 +69,32 @@ sql <- create_nitrate_analyse_table(version, last_year) ## 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 + +# Utiliser la fonction add_code_prelevement() avec la version souhaitée +nitrate_data_analyse_ars <- add_code_prelevement( + nitrate_data_analyse_ars, 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 + +# Utiliser la fonction add_code_analyse() avec la version souhaitée +nitrate_analyse_ars <- add_code_analyse( + nitrate_analyse_ars, version) + +``` + +