diff --git a/geau/DESCRIPTION b/geau/DESCRIPTION index 9c88698d843412671cf7925dbf443b19b37ff5d6..9f86f52ea6e1318139f32fdf49cb3374df7e756e 100644 --- a/geau/DESCRIPTION +++ b/geau/DESCRIPTION @@ -1,6 +1,6 @@ Package: geau Title: Utilities very useful to share within geau-inondation team -Version: 1.0.11.0 +Version: 1.0.11.1 Authors@R: c( person(given = "Frédéric", diff --git a/geau/R/map_so_ii.r b/geau/R/map_so_ii.r index 9f022e421a2a6b7df31ef268cb6af317b34ec133..57cc0033d8cf6ed7496881b1ad1395f79007f737 100644 --- a/geau/R/map_so_ii.r +++ b/geau/R/map_so_ii.r @@ -1,6 +1,30 @@ #' @title Plot a thematic map of so-ii #' #' @details +#' \subsection{theme specification}{ +#' For the specification of detail, it depends on the theme chosen. +#' \itemize{ +#' \item{\strong{none}: perimeter of so_ii is plotted.} +#' \item{\strong{catchment}: The area of catchments are plotted with a scope +#' depending on detail. At least, a division between Lez and +#' Bassin de l'Or is plotted.} +#' \item{\strong{catnat}: Informations on the number of "Arrêtés Cat +#' Nat are provided at the scale of collectivities."} +#' \item{\strong{collectivty}: Boundaries of collectivities are plotted, more +#' some administrative informations depending on detail.} +#' \item{\strong{hydro}: The hydrophic network is plotted. Depending on +#' detail, only a part (rivers, canals, water bodies) or a degre of detail +#' is plotted.} +#' \item{\strong{onrn}: Informations on the claims coming from Cat Nat system +#' are plotted at the scale of the collectivities. With detail a selection +#' of the data is made, with year a selection of the period.} +#' \item{\strong{osm}: A tile from OSM is plotted.} +#' \item{\strong{population}: Informations on the population coming from +#' INSEE are plotted at the scale of the collectivities. With year a +#' selection of the period is made, with detail a selection of how +#' evolution between 2 years.} +#' } +#' } #' \subsection{detail specification}{ #' For the specification of detail, it depends on the theme chosen. #' \itemize{ @@ -39,10 +63,10 @@ #' #' @param dataset sf objectf, data to be plotted #' @param dataset_legend list of parameters to be passed to legend -#' @param theme character, choice for the theme (if any) +#' @param theme character, choice for the theme (if any). See details. #' @param theme_legend logical, should a legend be plotted for the theme #' @param detail character, detail for theme, depends on theme. See details. -#' @param year character, the year chosen for some themes (catnat, population) +#' @param year character, the year chosen for some themes. See details. #' @param bar logical, should a bar be plotted for the dataset #' @param path character, the name of the file to save the plot #' @param ... some parameters that will be used by plot (from sf) @@ -533,6 +557,7 @@ map_theme_osm = function() { text = "Fond de carte : \u00a9 Contributeurs OpenStreetMap", side = 1, line = -1, adj = 1, cex = .6, font = 3 ) + return(NULL) } map_theme_population = function(detail, year, add_legend) { diff --git a/geau/man/map_so_ii.Rd b/geau/man/map_so_ii.Rd index 71b7535907045ac78fbdeac8ac41f673684910cf..8c7cb6de278f496250db3452ebe61e8dbde59568 100644 --- a/geau/man/map_so_ii.Rd +++ b/geau/man/map_so_ii.Rd @@ -23,13 +23,13 @@ map_so_ii( \item{dataset_legend}{list of parameters to be passed to legend} -\item{theme}{character, choice for the theme (if any)} +\item{theme}{character, choice for the theme (if any). See details.} \item{theme_legend}{logical, should a legend be plotted for the theme} \item{detail}{character, detail for theme, depends on theme. See details.} -\item{year}{character, the year chosen for some themes (catnat, population)} +\item{year}{character, the year chosen for some themes. See details.} \item{bar}{logical, should a bar be plotted for the dataset} @@ -44,6 +44,30 @@ Nothing useful. Plot a thematic map of so-ii } \details{ +\subsection{theme specification}{ +For the specification of detail, it depends on the theme chosen. +\itemize{ +\item{\strong{none}: perimeter of so_ii is plotted.} +\item{\strong{catchment}: The area of catchments are plotted with a scope +depending on detail. At least, a division between Lez and +Bassin de l'Or is plotted.} +\item{\strong{catnat}: Informations on the number of "Arrêtés Cat +Nat are provided at the scale of collectivities."} +\item{\strong{collectivty}: Boundaries of collectivities are plotted, more +some administrative informations depending on detail.} +\item{\strong{hydro}: The hydrophic network is plotted. Depending on +detail, only a part (rivers, canals, water bodies) or a degre of detail +is plotted.} +\item{\strong{onrn}: Informations on the claims coming from Cat Nat system +are plotted at the scale of the collectivities. With detail a selection +of the data is made, with year a selection of the period.} +\item{\strong{osm}: A tile from OSM is plotted.} +\item{\strong{population}: Informations on the population coming from +INSEE are plotted at the scale of the collectivities. With year a +selection of the period is made, with detail a selection of how +evolution between 2 years.} +} +} \subsection{detail specification}{ For the specification of detail, it depends on the theme chosen. \itemize{