From ef0450e21d2bb21b213edd8cc4f85c9b4f577f9b Mon Sep 17 00:00:00 2001 From: MGousseff Date: Wed, 25 Oct 2023 17:18:41 +0200 Subject: [PATCH] Added rasterMD.tif description. This file was provided by Matthias Demuzere and is used in examples for importLCZraster. --- R/data.R | 20 ++++++++++++++++++-- man/confidSensib.Rd | 6 +++--- man/produceAnalysis.Rd | 2 +- man/redonOSM.Rd | 3 +-- vignettes/lczexplore_raster_vector.Rmd | 1 + 5 files changed, 24 insertions(+), 8 deletions(-) diff --git a/R/data.R b/R/data.R index 5919f67..b8104ab 100644 --- a/R/data.R +++ b/R/data.R @@ -18,8 +18,7 @@ #' RedonOSM #' -#' Full baby name data provided by the SSA. This includes all names with at -#' least 5 uses. +#' #' #' @format An sf object with 3 variables and a geometry : #' \describe{ @@ -33,3 +32,20 @@ #' @name redonOSM #' @source "https://github.com/orbisgis/geoclimate" "redonOSM" + + +#' rasterMD.tif +#' +#' +#' +#' @format A .tif raster used to illustrate the import of several bands from a raster +#' \describe{ +#' \item{\code{lcz}}{a band with an lcz value for each pixel} +#' \item{\code{lczFilter}}{a band with a filtered lcz value for each pixel} +#' \item{\code{classProbability}}{a band which provides the probability associated to the lcz value, from 0 to 100} +#' } +#' +#' @docType tif file +#' @name rasterMD.tif +#' @source "https://doi.org/10.3389/fenvs.2021.637455" + diff --git a/man/confidSensib.Rd b/man/confidSensib.Rd index 2c9224d..9340289 100644 --- a/man/confidSensib.Rd +++ b/man/confidSensib.Rd @@ -71,10 +71,10 @@ or at least the columns must be in the same order. } \examples{ # creation of the comparison data on which to perform the analysis -redonCompare<-compareLCZ(sf1=redonBDT,wf1="bdt", geomID1 = "ID_RSU",column1 ="LCZ_PRIMARY", +redonCompare<-compareLCZ(sf1=redonBDT, wf1="bdt", geomID1 = "ID_RSU", column1 ="LCZ_PRIMARY", confid1 = "LCZ_UNIQUENESS_VALUE", - sf2=redonOSM, wf2="osm",geomID2 = "ID_RSU",column2="LCZ_PRIMARY", - confid2 ="LCZ_UNIQUENESS_VALUE",exwrite=FALSE,plot=FALSE) + sf2=redonOSM, wf2="osm",geomID2 = "ID_RSU", column2="LCZ_PRIMARY", + confid2 ="LCZ_UNIQUENESS_VALUE", exwrite=FALSE, plot=FALSE, saveG="") confidSensib(inputDf=redonCompare$data, nPoints=5, wf1="bdtopo_2_2", wf2="osm", geomID1="ID_RSU", column1="LCZ_PRIMARY", confid1="LCZ_UNIQUENESS_VALUE", diff --git a/man/produceAnalysis.Rd b/man/produceAnalysis.Rd index 4b734fd..77a0183 100644 --- a/man/produceAnalysis.Rd +++ b/man/produceAnalysis.Rd @@ -62,5 +62,5 @@ Same analysis are reproducible using all the generic functions of the package. } \examples{ produceAnalysis(location="Redon", outDir=paste0(system.file(package="lczexplore"),"/tinytest"), -wf1="bdtopo_2_2", wf2="osm", refYear1="2022", refYear2="2022", repr="standard", saveG=location) +wf1="bdtopo_2_2", wf2="osm", refYear1="2022", refYear2="2022", repr="standard", saveG="") } diff --git a/man/redonOSM.Rd b/man/redonOSM.Rd index 499679d..794da4f 100644 --- a/man/redonOSM.Rd +++ b/man/redonOSM.Rd @@ -20,7 +20,6 @@ An sf object with 3 variables and a geometry : redonOSM } \description{ -Full baby name data provided by the SSA. This includes all names with at -least 5 uses. +RedonOSM } \keyword{datasets} diff --git a/vignettes/lczexplore_raster_vector.Rmd b/vignettes/lczexplore_raster_vector.Rmd index 20e1849..843dbf6 100644 --- a/vignettes/lczexplore_raster_vector.Rmd +++ b/vignettes/lczexplore_raster_vector.Rmd @@ -201,6 +201,7 @@ a layer of confidence value. Notice one band was selected by its order in the ra This allows to also perform a confidence analysis on the agreement between two maps according to the level of confidence one allows to the LCZ value for each pixel. +The data used for this example come from Demuzere, M., Kittner, J., Bechtel, B. (2021). LCZ Generator: a web application to create Local Climate Zone maps. Frontiers in Environmental Science 9:637455. https://doi.org/10.3389/fenvs.2021.637455 ```{r, echo=TRUE, fig.show="hide"} # Dedicated files were integrated to demonstrate the whole workflow on an area of Sidney