From 45f55593febe557f5f58a887c1795ac6a05e152a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Grelot?= <frederic.grelot@irstea.fr>
Date: Wed, 19 Jan 2022 14:32:13 +0100
Subject: [PATCH] Ajout de l'aide
---
geau/man/current_version.Rd | 29 ++++++++++++++++++++++++
geau/man/kable_units.Rd | 2 +-
geau/man/map_so_ii.Rd | 44 +++++++++++++++++++++++++++++++++++++
geau/man/so_ii_commune.Rd | 33 ++++++++++++++++++++++++++++
geau/man/so_ii_limit.Rd | 30 +++++++++++++++++++++++++
geau/man/so_ii_scope.Rd | 17 ++++++++++++++
6 files changed, 154 insertions(+), 1 deletion(-)
create mode 100644 geau/man/current_version.Rd
create mode 100644 geau/man/map_so_ii.Rd
create mode 100644 geau/man/so_ii_commune.Rd
create mode 100644 geau/man/so_ii_limit.Rd
create mode 100644 geau/man/so_ii_scope.Rd
diff --git a/geau/man/current_version.Rd b/geau/man/current_version.Rd
new file mode 100644
index 0000000..14579d8
--- /dev/null
+++ b/geau/man/current_version.Rd
@@ -0,0 +1,29 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/current_version.r
+\encoding{UTF-8}
+\name{current_version}
+\alias{current_version}
+\title{Find the current version of some data}
+\usage{
+current_version(path, ...)
+}
+\arguments{
+\item{path}{character path to a directory where to find data}
+
+\item{...}{some extra parameters that will be passed to dir(path, ...)}
+}
+\value{
+character path of the file corresponding the current version of the data
+}
+\description{
+Find the current version of some data
+}
+\examples{
+
+\dontrun{
+# To be added (soon)
+}
+}
+\author{
+Frédéric Grelot
+}
diff --git a/geau/man/kable_units.Rd b/geau/man/kable_units.Rd
index be097bf..601d178 100644
--- a/geau/man/kable_units.Rd
+++ b/geau/man/kable_units.Rd
@@ -1,5 +1,5 @@
% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/kable_units.R
+% Please edit documentation in R/kable_units.r
\encoding{UTF-8}
\name{kable_units}
\alias{kable_units}
diff --git a/geau/man/map_so_ii.Rd b/geau/man/map_so_ii.Rd
new file mode 100644
index 0000000..e30453a
--- /dev/null
+++ b/geau/man/map_so_ii.Rd
@@ -0,0 +1,44 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/map_so_ii.r
+\encoding{UTF-8}
+\name{map_so_ii}
+\alias{map_so_ii}
+\title{Plot a thematic map of so-ii}
+\usage{
+map_so_ii(
+ dataset,
+ dataset_legend = NULL,
+ theme = "clc",
+ bar = TRUE,
+ path = NULL,
+ ...
+)
+}
+\arguments{
+\item{dataset}{sf objectf, data to be plotted}
+
+\item{dataset_legend}{list of parameters to be passed to legend}
+
+\item{theme}{character, choice for the theme (if any)}
+
+\item{bar}{logical, should a bar be plotted}
+
+\item{path}{character, the name of the file to save the plot}
+
+\item{...}{some parameters that will be used by plot (from sf)}
+}
+\value{
+Nothing useful.
+}
+\description{
+Plot a thematic map of so-ii
+}
+\examples{
+
+\dontrun{
+# To be added (soon)
+}
+}
+\author{
+Frédéric Grelot
+}
diff --git a/geau/man/so_ii_commune.Rd b/geau/man/so_ii_commune.Rd
new file mode 100644
index 0000000..979256f
--- /dev/null
+++ b/geau/man/so_ii_commune.Rd
@@ -0,0 +1,33 @@
+% 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}
+\{statut}{character, "statut" of the commune}
+\{pop_yyy}{integer, official population of year yyyy in the commune}
+\{epci}{characeter, 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}
diff --git a/geau/man/so_ii_limit.Rd b/geau/man/so_ii_limit.Rd
new file mode 100644
index 0000000..c54cc95
--- /dev/null
+++ b/geau/man/so_ii_limit.Rd
@@ -0,0 +1,30 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/data.r
+\docType{data}
+\name{so_ii_limit}
+\alias{so_ii_limit}
+\title{Spatial perimeter of so-ii}
+\format{
+sfc_POLYGON of length 1
+
+sf data.frame 1337 rows, 2 variables
+\describe{
+\item{clc_2018}{character, classification from CLC 2018}
+\item{color}{character, default color to be used to plot so_ii_clc}
+}
+}
+\usage{
+so_ii_limit
+
+so_ii_limit
+}
+\description{
+A dataset containing the perimeter of so-ii.
+
+A dataset containing the Corine Land Cover information on so-ii.
+}
+\details{
+Basically, this dataset is obtained as
+\code{sf::st_union(so_ii_commune)}
+}
+\keyword{datasets}
diff --git a/geau/man/so_ii_scope.Rd b/geau/man/so_ii_scope.Rd
new file mode 100644
index 0000000..ad93280
--- /dev/null
+++ b/geau/man/so_ii_scope.Rd
@@ -0,0 +1,17 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/data.r
+\docType{data}
+\name{so_ii_scope}
+\alias{so_ii_scope}
+\title{Local collectivities included in so-ii}
+\format{
+a vector of 69 INSEE code
+}
+\usage{
+so_ii_scope
+}
+\description{
+A dataset containing the INSEE code of all local collectivities
+(communes) included in so-ii
+}
+\keyword{datasets}
--
GitLab