Resolve "add catchment data"

Closes #4 (closed)

geau/R/data.r

@@ -3,31 +3,39 @@
 #' A dataset containing the INSEE code of all local collectivities
 #' (communes) included in so-ii
 #'
-#' @format a vector of 69 INSEE code
+#' @format a vector of 78 INSEE code
 "so_ii_scope"
 
-#' List of all collectivities included in so-ii
+#' Spatial definition of collectivities included in so-ii
 #'
-#' A dataset containing the INSEE code of all local collectivities
-#' included in so-ii.
+#' A dataset containing the spatial definition of all collectivities
+#' included in so-ii and some administrative informations.
 #'
+#' @details
 #' Basically this dataset is obtained as a selection from the layer
-#' COMMUNE in ADMIN EXPRESS, more a renaming of variables.
+#' COMMUNE in ADMIN EXPRESS, more a renaming of variables. It is then added
+#' information from EPCI in ADMIN EXPRESS and the membership to SYBLE and
+#' SYMBO.
 #'
-#' @format sf data.frame 69 rows, 7 variables
+#' @format sf data.frame 78 rows, 11 variables
 #' \describe{
-#'   \item{id}{id, from IGN ADMIN EXPRESS}
-#'   \item{commune}{character, official name of the commune}
-#'   \item{commune_majuscule}{character, official capitalized name of the
-#'         commune}
-#'   \item{code}{character, INSEE code of the commune}
-#'   \item{statut}{character, statut of the commune}
-#'   \item{pop_yyy}{integer, official population of year yyyy in the commune}
-#'   \item{epci}{character, INSEE ID of the EPCI of the commune}
+#'   \item{commune_name}{character, INSEE code of the collectivity}
+#'   \item{syble}{logical, membership in SYBLE}
+#'   \item{symbo}{logical, membership in SYMBO}
+#'   \item{commune_name}{character, official name of the collectivity}
+#'   \item{commune_name_cap}{character, official capitalized name of the
+#'          collectivity}
+#'   \item{departement}{character, INSEE code of the departement of the
+#'          collectivity}
+#'   \item{region}{character, INSEE code of the region of the
+#'          collectivity}
+#'   \item{epci}{character, INSEE code of the EPCI of the collectivity}
+#'   \item{epci_name}{character, Name of the EPCI of the collectivity}
+#'   \item{epci_nature}{character, Nature of the EPCI of the collectivity}
 #' }
 #'
 #' @source \url{https://www.data.gouv.fr/fr/datasets/admin-express/}
-"so_ii_commune"
+"so_ii_collectivity"
 
 #' Spatial perimeter of so-ii
 #'
@@ -100,9 +108,12 @@
 #' @format sf data.frame 125 rows, 4 variables
 #' \describe{
 #'   \item{id}{id, from BD TOPAGE (corresponding to CdOh)}
-#'   \item{name}{character, name of the river or part of the river in BD
-#'      TOPAGE}
-#'   \item{degre}{character, level of detail to plot the hydrographic network}
+#'   \item{name}{character, name of the hydrographic elements in the BD TOPAGE}
+#'   \item{degre}{factor, level of importance of the hydrographic element
+#'      used to plot the hydrographic network with different levels of
+#'      detail ("1", "2", "3").}
+#'   \item{type}{factor, type of hydrographic element ("canal", "river",
+#'      "waterbody")}
 #' }
 #'
 #' @source \url{http://bdtopage.eaufrance.fr/page/objectifs}
@@ -111,13 +122,18 @@
 #' Catchment areas of interest within the so-ii perimeter
 #'
 #' A dataset containing the official catchments areas of interest from the BD 
-#' TOPAGE within the so-ii perimeter.
+#' TOPAGE within the so-ii perimeter. For degre = 3, the data are basically
+#' what is found in BD TOPAGE. For degres 1 and 2, the data result from
+#' sf::st_union of data of degre 3 to give a more synthetic representation.
 #'
 #' @format sf data.frame 15 rows, 4 variables
 #' \describe{
-#'   \item{id}{id, from BD TOPAGE (corresponding to CdOh)}
-#'   \item{name}{character, name of the catchment area in BD TOPAGE}
-#'   \item{degre}{character, level of detail to plot the catchment area}
+#'   \item{id}{id, from BD TOPAGE (corresponding to CdOh) or NA when catchment
+#'      is constructed by so-ii team.}
+#'   \item{name}{character, name of the catchment area in BD TOPAGE, or given
+#'      name for catchments constructed by so-ii team.}
+#'   \item{degre}{factor, importance of the catchment used to plot the
+#'      catchment areas with different levels of detail ("1", "2", "3").}
 #' }
 #'
 #' @source \url{http://bdtopage.eaufrance.fr/page/objectifs}

geau/R/map_so_ii.r

 #' @title Plot a thematic map of so-ii
 #' 
-#' @details 
-#' For theme "catnat", detail must be chosen in c("inondation", "submersion",
-#'  "nappe").
-#' For theme "hydro" detail must be chosen in "0", "1", "2", "3" or "canal".
+#' @details
+#' \subsection{detail specification}{
+#' For the specification of detail, it depends on the theme chosen.
+#' \itemize{
+#'   \item{\strong{catnat}: detail must be chosen in "inondation",
+#'      "submersion", or "nappe". If missing all type will be chosen and
+#'      aggregated before plotting.}
+#'   \item{\strong{catchment}: detail must be chosen in "none", "1", "2", "3"
+#'      for levels of detail. If missing, "1" will be chosen.}
+#'   \item{\strong{collectivity}: detail must be chosen in "none", "syble",
+#'      "symbo", "epci" or "syndicate". If missing, "none" will be chosen,
+#'      and only the boundaries of collectivities are plotted.}
+#'   \item{\strong{hydro}: detail must be chosen in "none", "1", "2", "3" for
+#'      levels of detail or "canal", "river", "waterbody" for types of
+#'      hydrographic elements. If missing, "none" will be chosen, and
+#'      everything is plotted.}
+#' }
+#' }
+#' \subsection{year specification}{
+#' For the specification of year, it depends on the theme chosen.
+#' \itemize{
+#'   \item{\strong{catnat}: year corresponds to the year of data. If missing,
+#'      nothing is plotted.}
+#'   \item{\strong{population}: year corresponds to the year of data. If
+#'      missing, last available year is plotted.}
+#' }
+#' }
 #' 
 #' @param dataset sf objectf, data to be plotted
 #' @param dataset_legend list of parameters to be passed to legend
@@ -12,7 +35,7 @@
 #' @param path character, the name of the file to save the plot
 #' @param legend_theme logical, should a legend be plotted for the theme
 #' @param year character, the year chosen for some themes (catnat, population)
-#' @param detail character, detail for theme, depends on theme
+#' @param detail character, detail for theme, depends on theme. See details.
 #' @param ...  some parameters that will be used by plot (from sf)
 #'
 #' @return Nothing useful.
@@ -21,6 +44,7 @@
 #'
 #' @encoding UTF-8
 #' @author Frédéric Grelot
+#' @author David Nortes Martinez
 #' 
 #' @examples
 #' 
@@ -31,7 +55,7 @@
 map_so_ii = function(
     dataset,
     dataset_legend = NULL,
-    theme = c("none", "clc", "catnat", "hydro", "population", "catchment"),
+    theme = c("none", "collectivity", "catchment", "catnat", "clc", "hydro", "population"),
     bar = TRUE,
     path = NULL,
     legend_theme = FALSE,
@@ -55,6 +79,63 @@ map_so_ii = function(
     graphics::par(mai = c(.65, .60, .50, .15))
     plot(geau::so_ii_limit, axes = TRUE)
 
+    if ("collectivity" %in% theme) {
+        if (missing(detail)) {
+            detail = "none"
+        }
+        detail = match.arg(
+            detail, 
+            c("none", "syble", "symbo", "epci", "syndicate")
+        )
+
+        border = "grey80"
+        color = NA
+
+        theme_legend = list(
+            title = "Caract\u00e9ristiques des communes",
+            legend = "Commune",
+            x = "topright",
+            cex = .8,
+            bg = "white",
+            inset = 0.01,
+            fill = color,
+            border = border
+        )
+        geometry = geau::so_ii_collectivity[["geometry"]]
+        plot(geometry, border = border, col = color, add = TRUE)
+        
+        if (detail %in% c("syble", "syndicate")) {
+            color_legend = scales::alpha("orange", .3)
+            color = ifelse(
+                geau::so_ii_collectivity[["syble"]],
+                color_legend,
+                NA
+            )
+            plot(geometry, border = border, col = color, add = TRUE)
+            theme_legend[["legend"]] = c(theme_legend[["legend"]], "SYBLE")
+            theme_legend[["fill"]] = c(theme_legend[["fill"]], color_legend)  
+        }
+        if (detail %in% c("symbo", "syndicate")) {
+            color_legend = scales::alpha("green", .3)
+            color = ifelse(
+                geau::so_ii_collectivity[["symbo"]],
+                color_legend,
+                NA
+            )
+            plot(geometry, border = border, col = color, add = TRUE)
+            theme_legend[["legend"]] = c(theme_legend[["legend"]], "SYMBO")
+            theme_legend[["fill"]] = c(theme_legend[["fill"]], color_legend) 
+        }
+        if (detail == "epci") {
+            epci = as.factor(geau::so_ii_collectivity[["epci_name"]])
+            color_legend = grDevices::hcl.colors(nlevels(epci), "Lisbon", alpha = .3)
+            color = color_legend[epci]
+            plot(geometry, border = border, col = color, add = TRUE)
+            theme_legend[["legend"]] = levels(epci)
+            theme_legend[["fill"]] = color_legend
+        }
+    }
+
     if ("clc" %in% theme) {
         plot(
             geau::so_ii_clc[["geometry"]],
@@ -89,7 +170,7 @@ map_so_ii = function(
         )
         border = "grey80"
         plot(
-            geau::so_ii_commune[["geometry"]],
+            geau::so_ii_collectivity[["geometry"]],
             border = border,
             col = color[ , year],
             add = TRUE
@@ -155,7 +236,7 @@ map_so_ii = function(
         }
 
         plot(
-            geau::so_ii_commune[["geometry"]],
+            geau::so_ii_collectivity[["geometry"]],
             border = border,
             col = color,
             add = TRUE
@@ -164,63 +245,71 @@ map_so_ii = function(
 
     if ("hydro" %in% theme) {
         if (missing(detail)) {
-            detail = "0"
+            detail = "none"
         }
         detail = match.arg(
             as.character(detail),
-            choices = c("0", "1", "2", "3", "canal")
+            choices = c(
+                "none",
+                levels(geau::so_ii_hydro[["degre"]]),
+                levels(geau::so_ii_hydro[["type"]])
+            )
         )
-        if (detail == "canal") {
-            selection  = geau::so_ii_hydro[["degre"]] == detail
-            geometry = geau::so_ii_hydro[["geometry"]][selection]
-            color = scales::alpha("red", .3)
-            lwd = 1
-        } else {
-            selection  = geau::so_ii_hydro[["degre"]] <= detail
-            geometry = geau::so_ii_hydro[["geometry"]][selection]
-            color =  scales::alpha("blue", .3)
-            lwd = 4 - as.numeric(geau::so_ii_hydro[["degre"]][selection])
-        }
-
-        plot(geometry, col = color, lwd = lwd, add = TRUE)
-
+        color = scales::alpha("blue", .3)
+        bg = scales::alpha("blue", .3)
+        border = NA
+        selection = seq(nrow(geau::so_ii_hydro))
         theme_legend = list(
             title = sprintf("R\u00e9seau hydrographique"),
-            legend = ifelse(detail == "canal", "canal", "cours d'eau"),
+            legend = "\u00e9l\u00e9ment du r\u00e9seau",
             x = "topright",
             cex = .8,
             bg = "white",
             inset = 0.01,
             col = color,
-            lwd = 2
+            lwd = 1
         )
+        if (detail %in% levels(geau::so_ii_hydro[["type"]])) {
+            selection  = as.character(geau::so_ii_hydro[["type"]]) == detail
+            theme_legend[["legend"]] = detail
+        }
+        if (detail %in% levels(geau::so_ii_hydro[["degre"]])) {
+            selection  = as.character(geau::so_ii_hydro[["degre"]]) <= detail
+        }
+        geometry = geau::so_ii_hydro[["geometry"]][selection]
+        lwd = 4 - as.numeric(geau::so_ii_hydro[["degre"]][selection])
+
+        plot(geometry, col = color, lwd = lwd, border = border, add = TRUE)
     }
 
     if ("catchment" %in% theme) {
         if (missing(detail)) {
-            detail = "0"
+            detail = "1"
         }
         detail = match.arg(
-            as.character(detail),
-            choices = c("0", "1", "2")
+            as.character(detail), 
+            choices = levels(geau::so_ii_catchment[["degre"]])
         )
         selection  = geau::so_ii_catchment[["degre"]] == detail
         geometry = geau::so_ii_catchment[["geometry"]][selection]
+        catchment = as.factor(geau::so_ii_catchment[["catchment_name"]][selection])
+        color_legend = grDevices::hcl.colors(nlevels(catchment), "Pastel 1", alpha = .3)
+        color = color_legend[catchment]
         border = "grey80"
-        color =  scales::alpha("grey80", .5)
-        lwd = 1
-        plot(geometry, border = border, col = color, lwd = lwd, add = TRUE)
-
+        lwd = 2
         theme_legend = list(
-            title = sprintf("Unit\u00e9 administrative"),
-            legend = "Bassin versant",
+            title = sprintf("Bassin versant"),
+            legend = levels(catchment),
             x = "topright",
             cex = .8,
             bg = "white",
             inset = 0.01,
-            fill = unique(color),
+            fill = color_legend,
             border = border
         )
+        if (detail == "3") rm(theme_legend)
+
+        plot(geometry, border = border, col = color, lwd = lwd, add = TRUE)
     }
 
     if (!missing(dataset)) plot(dataset[["geometry"]], add = TRUE, ...)

geau/data-raw/so_ii_catchment.R

 # code to prepare `so_ii_catchment` dataset goes here
 
-file_dir = current_version(
+file_dir = geau::current_version(
     "data-common/so-ii/topage",
     pattern = "^[0-9-]+$"
 )
-so_ii_catchment = sf::st_read(file.path(file_dir, "bassin_versant_so_ii.shp"))
-
-classification = read.csv(
-    current_version("data-common/so-ii/topage", pattern = "catchment"),
-    colClasses = "character"
-)
-# establishing levels of detail in catchments
-so_ii_catchment[["degre"]] = 2
-
-bassin_mosson = so_ii_catchment[so_ii_catchment[["id"]] %in% classification[["id"]][classification[["soussecteur"]] == "mosson"], ]
-bassin_mosson_geom = sf::st_union(bassin_mosson)
-bassin_mosson_df = data.frame(
-    id = "soii01",
-    bassin = "Bassin Mosson",
-    degre = 1
-)
-bassin_mosson = sf::st_set_geometry(bassin_mosson_df, bassin_mosson_geom)
-
-bassin_lez = so_ii_catchment[so_ii_catchment[["id"]] %in% classification[["id"]][classification[["soussecteur"]] == "lez"], ]
-bassin_lez_geom = sf::st_union(bassin_lez)
-bassin_lez_df = data.frame(
-    id = "soii02",
-    bassin = "Bassin Lez",
-    degre = 1
-)
-bassin_lez = sf::st_set_geometry(bassin_lez_df, bassin_lez_geom)
-
-bassin_lor = so_ii_catchment[so_ii_catchment[["id"]] %in% classification[["id"]][classification[["soussecteur"]] == "lor"], ]
-bassin_lor_geom = sf::st_union(bassin_lor)
-bassin_lor_df = data.frame(
-    id = "soii03",
-    bassin = "Bassin L'or",
-    degre = 1
-)
-bassin_lor = sf::st_set_geometry(bassin_lor_df, bassin_lor_geom)
-
-so_ii_catchment = rbind(so_ii_catchment, bassin_mosson)
-so_ii_catchment = rbind(so_ii_catchment, bassin_lez)
-so_ii_catchment = rbind(so_ii_catchment, bassin_lor) 
+so_ii_catchment = sf::st_read(file.path(file_dir, "bassin_versant.shp"))
+names(so_ii_catchment) = c("id", "catchment_name", "degre", "geometry")
+Encoding(so_ii_catchment[["catchment_name"]]) = "UTF-8"
+so_ii_catchment[["degre"]] = factor(so_ii_catchment[["degre"]])
 
 # updating datasets
 
-# actual = setwd(file.path(system.file(package = "geau"), ".."))
 actual = setwd("geau")
 usethis::use_data(so_ii_catchment, internal = FALSE, overwrite = TRUE)
 setwd(actual)

geau/data-raw/so_ii_collectivity.R

+# code to prepare `so_ii_collectivity` and `so_ii_limit` datasets goes here
+
+## epci
+
+so_ii_epci = read.csv2(
+    geau::current_version("data-common/so-ii/epci")
+)
+rownames(so_ii_epci) = so_ii_epci[["epci"]]
+epci = names(so_ii_epci)
+
+## collectivity
+
+admin_express = geau::current_version("data-common/data/IGN/ADMIN-EXPRESS/version")
+so_ii_collectivity = sf::st_read(file.path(admin_express, "COMMUNE.shp"))
+so_ii_collectivity = so_ii_collectivity["INSEE_COM"]
+names(so_ii_collectivity) = c("commune", "geometry")
+rownames(so_ii_collectivity) = so_ii_collectivity[["commune"]]
+so_ii_collectivity = so_ii_collectivity[geau::so_ii_scope, ]
+
+so_ii_collectivity = merge(
+    so_ii_collectivity[geau::so_ii_scope, ],
+    read.csv2(geau::current_version("data-common/so-ii/commune"))
+)
+collectivity = names(so_ii_collectivity)[-length(names(so_ii_collectivity))]
+
+so_ii_collectivity = merge(so_ii_collectivity, so_ii_epci)
+
+rownames(so_ii_collectivity) = so_ii_collectivity[["commune"]]
+so_ii_collectivity = so_ii_collectivity[
+    geau::so_ii_scope,
+    union(collectivity, epci)
+]
+Encoding(so_ii_collectivity[["commune_name"]]) = "UTF-8"
+Encoding(so_ii_collectivity[["epci_name"]]) = "UTF-8"
+Encoding(so_ii_collectivity[["epci_nature"]]) = "UTF-8"
+
+so_ii_limit = sf::st_union(so_ii_collectivity)
+
+# updating dataset
+
+actual = setwd("geau")
+usethis::use_data(so_ii_collectivity, internal = FALSE, overwrite = TRUE)
+usethis::use_data(so_ii_limit, internal = FALSE, overwrite = TRUE)
+setwd(actual)

geau/data-raw/so_ii_hydro.R

 # code to prepare `so_ii_hydro` dataset goes here
 
 selection = c("CdOH", "TopoOH")
-file_dir = current_version(
+file_dir = geau::current_version(
     "data-common/so-ii/topage",
     pattern = "^[0-9-]+$"
 )
-so_ii_hydro = sf::st_read(file.path(file_dir, "cours-eau-so-ii.shp"))
-so_ii_hydro = sf::st_transform(
-    so_ii_hydro[selection],
+river = sf::st_read(file.path(file_dir, "cours_eau.shp"))
+river = sf::st_transform(
+    river[selection],
     sf::st_crs(geau::so_ii_limit)
 )
-names(so_ii_hydro) = c("id", "name", "geometry")
+names(river) = c("id", "name", "geometry")
 
 classification = read.csv2(
-    current_version("data-common/so-ii/topage", pattern = "courseau"),
+    geau::current_version("data-common/so-ii/topage", pattern = "cours_eau"),
+    colClasses = "character",
+    row.names = 1
+)
+river = merge(river, classification)
+
+waterbody = sf::st_read(file.path(file_dir, "plan_eau.shp"))
+waterbody[["name"]] = gsub("C[?]ur", "Cœur", waterbody[["name"]])
+
+classification = read.csv2(
+    geau::current_version("data-common/so-ii/topage", pattern = "plan_eau"),
     colClasses = "character"
-)[c("id", "name", "degre")]
+)
+waterbody = merge(waterbody, classification)
+
+so_ii_hydro = rbind(river, waterbody)
 
-so_ii_hydro = merge(so_ii_hydro, classification)
+so_ii_hydro[["degre"]] = factor(so_ii_hydro[["degre"]])
+so_ii_hydro[["type"]] = factor(so_ii_hydro[["type"]])
+Encoding(waterbody[["name"]]) = "UTF-8"
 
 # updating datasets
 
-# actual = setwd(file.path(system.file(package = "geau"), ".."))
 actual = setwd("geau")
 usethis::use_data(so_ii_hydro, internal = FALSE, overwrite = TRUE)
 setwd(actual)

geau/data-raw/so_ii_scope.R

@@ -6,19 +6,6 @@ so_ii_scope = read.csv2(
 )[["code"]]
 so_ii_scope = sort(so_ii_scope)
 
-# code to prepare `so_ii_commune` dataset goes here
-
-admin_express = current_version("data-common/data/IGN/ADMIN-EXPRESS/version")
-selection = c("ID", "NOM", "NOM_M", "INSEE_COM", "STATUT", "POPULATION", "SIREN_EPCI")
-so_ii_commune = sf::st_read(file.path(admin_express, "COMMUNE.shp"))[selection]
-names(so_ii_commune) = c("id", "commune", "commune_majuscule", "code", "statut", "pop_2021", "epci", "geometry")
-rownames(so_ii_commune) = so_ii_commune[["code"]]
-so_ii_commune = so_ii_commune[so_ii_scope, ]
-
-# code to prepare `so_ii_limit` dataset goes here
-
-so_ii_limit = sf::st_union(so_ii_commune)
-
 # code to prepare `so_ii_clc` dataset goes here
 
 so_ii_clc = readRDS("data-common/data/so-ii/so-ii_clc.rds")
@@ -63,8 +50,6 @@ so_ii_clc[["color"]] = as.character(
 # actual = setwd(file.path(system.file(package = "geau"), ".."))
 actual = setwd("geau")
 usethis::use_data(so_ii_scope, internal = FALSE, overwrite = TRUE)
-usethis::use_data(so_ii_commune, internal = FALSE, overwrite = TRUE)
-usethis::use_data(so_ii_limit, internal = FALSE, overwrite = TRUE)
 usethis::use_data(so_ii_clc, internal = FALSE, overwrite = TRUE)
 usethis::use_data(clc_color, internal = FALSE, overwrite = TRUE)
 setwd(actual)

geau/man/map_so_ii.Rd

@@ -8,7 +8,8 @@
 map_so_ii(
   dataset,
   dataset_legend = NULL,
-  theme = c("none", "clc", "catnat", "hydro"),
+  theme = c("none", "collectivity", "catchment", "catnat", "clc", "hydro",
+    "population"),
   bar = TRUE,
   path = NULL,
   legend_theme = FALSE,
@@ -32,7 +33,7 @@ map_so_ii(
 
 \item{year}{character, the year chosen for some themes (catnat, population)}
 
-\item{detail}{character, detail for theme, depends on theme}
+\item{detail}{character, detail for theme, depends on theme. See details.}
 
 \item{...}{some parameters that will be used by plot (from sf)}
 }
@@ -43,9 +44,32 @@ Nothing useful.
 Plot a thematic map of so-ii
 }
 \details{
-For theme "catnat", detail must be chosen in c("inondation", "submersion",
-"nappe").
-For theme "hydro" detail must be chosen in "0", "1", "2", "3" or "canal".
+\subsection{detail specification}{
+For the specification of detail, it depends on the theme chosen.
+\itemize{
+\item{\strong{catnat}: detail must be chosen in "inondation",
+"submersion", or "nappe". If missing all type will be chosen and
+aggregated before plotting.}
+\item{\strong{catchment}: detail must be chosen in "none", "1", "2", "3"
+for levels of detail. If missing, "1" will be chosen.}
+\item{\strong{collectivity}: detail must be chosen in "none", "syble",
+"symbo", "epci" or "syndicate". If missing, "none" will be chosen,
+and only the boundaries of collectivities are plotted.}
+\item{\strong{hydro}: detail must be chosen in "none", "1", "2", "3" for
+levels of detail or "canal", "river", "waterbody" for types of
+hydrographic elements. If missing, "none" will be chosen, and
+everything is plotted.}
+}
+}
+\subsection{year specification}{
+For the specification of year, it depends on the theme chosen.
+\itemize{
+\item{\strong{catnat}: year corresponds to the year of data. If missing,
+nothing is plotted.}
+\item{\strong{population}: year corresponds to the year of data. If
+missing, last available year is plotted.}
+}
+}
 }
 \examples{
 
@@ -55,4 +79,6 @@ For theme "hydro" detail must be chosen in "0", "1", "2", "3" or "canal".
 }
 \author{
 Frédéric Grelot
+
+David Nortes Martinez
 }

geau/man/so_ii_catchment.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/data.r
+\docType{data}
+\name{so_ii_catchment}
+\alias{so_ii_catchment}
+\title{Catchment areas of interest within the so-ii perimeter}
+\format{
+sf data.frame 15 rows, 4 variables
+\describe{
+\item{id}{id, from BD TOPAGE (corresponding to CdOh) or NA when catchment
+is constructed by so-ii team.}
+\item{name}{character, name of the catchment area in BD TOPAGE, or given
+name for catchments constructed by so-ii team.}
+\item{degre}{factor, importance of the catchment used to plot the
+catchment areas with different levels of detail ("1", "2", "3").}
+}
+}
+\source{
+\url{http://bdtopage.eaufrance.fr/page/objectifs}
+}
+\usage{
+so_ii_catchment
+}
+\description{
+A dataset containing the official catchments areas of interest from the BD
+TOPAGE within the so-ii perimeter. For degre = 3, the data are basically
+what is found in BD TOPAGE. For degres 1 and 2, the data result from
+sf::st_union of data of degre 3 to give a more synthetic representation.
+}
+\keyword{datasets}

geau/man/so_ii_collectivity.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/data.r
+\docType{data}
+\name{so_ii_collectivity}
+\alias{so_ii_collectivity}
+\title{Spatial definition of collectivities included in so-ii}
+\format{
+sf data.frame 78 rows, 11 variables
+\describe{
+\item{commune_name}{character, INSEE code of the collectivity}
+\item{syble}{logical, membership in SYBLE}
+\item{symbo}{logical, membership in SYMBO}
+\item{commune_name}{character, official name of the collectivity}
+\item{commune_name_cap}{character, official capitalized name of the
+collectivity}
+\item{departement}{character, INSEE code of the departement of the
+collectivity}
+\item{region}{character, INSEE code of the region of the
+collectivity}
+\item{epci}{character, INSEE code of the EPCI of the collectivity}
+\item{epci_name}{character, Name of the EPCI of the collectivity}
+\item{epci_nature}{character, Nature of the EPCI of the collectivity}
+}
+}
+\source{
+\url{https://www.data.gouv.fr/fr/datasets/admin-express/}
+}
+\usage{
+so_ii_collectivity
+}
+\description{
+A dataset containing the spatial definition of all collectivities
+included in so-ii and some administrative informations.
+}
+\details{
+Basically this dataset is obtained as a selection from the layer
+COMMUNE in ADMIN EXPRESS, more a renaming of variables. It is then added
+information from EPCI in ADMIN EXPRESS and the membership to SYBLE and
+SYMBO.
+}
+\keyword{datasets}

geau/man/so_ii_commune.Rd

-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/data.r
-\docType{data}
-\name{so_ii_commune}
-\alias{so_ii_commune}
-\title{List of all collectivities included in so-ii}
-\format{
-sf data.frame 69 rows, 7 variables
-\describe{
-\item{id}{id, from IGN ADMIN EXPRESS}
-\item{commune}{character, official name of the commune}
-\item{commune_majuscule}{character, official capitalized name of the
-commune}
-\item{code}{character, INSEE code of the commune}
-\item{statut}{character, statut of the commune}
-\item{pop_yyy}{integer, official population of year yyyy in the commune}
-\item{epci}{character, INSEE ID of the EPCI of the commune}
-}
-}
-\source{
-\url{https://www.data.gouv.fr/fr/datasets/admin-express/}
-}
-\usage{
-so_ii_commune
-}
-\description{
-A dataset containing the INSEE code of all local collectivities
-included in so-ii.
-}
-\details{
-Basically this dataset is obtained as a selection from the layer
-COMMUNE in ADMIN EXPRESS, more a renaming of variables.
-}
-\keyword{datasets}

geau/man/so_ii_hydro.Rd

@@ -8,9 +8,12 @@
 sf data.frame 125 rows, 4 variables
 \describe{
 \item{id}{id, from BD TOPAGE (corresponding to CdOh)}
-\item{name}{character, name of the river or part of the river in BD
-TOPAGE}
-\item{degre}{character, level of detail to plot the hydrographic network}
+\item{name}{character, name of the hydrographic elements in the BD TOPAGE}
+\item{degre}{factor, level of importance of the hydrographic element
+used to plot the hydrographic network with different levels of
+detail ("1", "2", "3").}
+\item{type}{factor, type of hydrographic element ("canal", "river",
+"waterbody")}
 }
 }
 \source{