Commit 45f55593 authored by Grelot Frederic's avatar Grelot Frederic :swimmer_tone5:
Browse files

Ajout de l'aide

Showing with 154 additions and 1 deletion
+154 -1
% 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
}
% 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}
......
% 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
}
% 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}
% 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}
% 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}
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment