diff --git a/geau/R/map_so_ii.r b/geau/R/map_so_ii.r index 7b4d10cfea280f0650e3d2a30833f4703b3f5974..323a2906fcf285cdab7ea5e54695b17ceb7c845f 100644 --- a/geau/R/map_so_ii.r +++ b/geau/R/map_so_ii.r @@ -1,11 +1,17 @@ #' @title Plot a thematic map of so-ii #' #' @details -#' For theme "collectivity" detail must be chosen in c("none", "syble", "symbo", -#' "epci", "syndicate"). -#' 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.} +#' \item{\strong{collectivity}: detail must be chosen in "none", "syble", "symbo", +#' "epci" or "syndicate". If missing "none" will be chosen.} +#' \item{\strong{hydro}: detail must be chosen in "0", "1", "2", "3" or "canal". +#' If missing "0" will be chosen.} +#' } +#' } #' #' @param dataset sf objectf, data to be plotted #' @param dataset_legend list of parameters to be passed to legend @@ -14,7 +20,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. @@ -23,6 +29,7 @@ #' #' @encoding UTF-8 #' @author Frédéric Grelot +#' @author David Nortes Martinez #' #' @examples #' diff --git a/geau/man/map_so_ii.Rd b/geau/man/map_so_ii.Rd index 3ff733788f0fbbdfe571fc42ba96250d4f69d747..6543883e2d84f1edd800e91656817cc05e172759 100644 --- a/geau/man/map_so_ii.Rd +++ b/geau/man/map_so_ii.Rd @@ -32,7 +32,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,11 +43,17 @@ Nothing useful. Plot a thematic map of so-ii } \details{ -For theme "collectivity" detail must be chosen in c("none", "syble", "symbo", -"epci", "syndicate"). -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.} +\item{\strong{collectivity}: detail must be chosen in "none", "syble", "symbo", +"epci" or "syndicate". If missing "none" will be chosen.} +\item{\strong{hydro}: detail must be chosen in "0", "1", "2", "3" or "canal". +If missing "0" will be chosen.} +} +} } \examples{ @@ -57,4 +63,6 @@ For theme "hydro" detail must be chosen in "0", "1", "2", "3" or "canal". } \author{ Frédéric Grelot + +David Nortes Martinez }