Package: lczexplore 0.1.1

Matthieu Gousseff

lczexplore: Imports, Visualizes, Compares and Explores Maps of Local Climate Zones

Easily import and visualize local climate zone maps with standard encoding. Compare two or more maps, and group some LCZ types according to user defined grouping vectors. Explore their differences through circular visualization and indicators. For more Details see Gousseff et al (2023) "lczexplore: an R package to explore Local Climate Zone classifications" <doi:10.21105/joss.05445>.

Authors:Matthieu Gousseff [aut, cre, cph]

lczexplore_0.1.1.tar.gz
lczexplore_0.1.1.zip(r-4.7-any)lczexplore_0.1.1.zip(r-4.6-any)
lczexplore_0.1.1.tar.gz(r-4.7-any)lczexplore_0.1.1.tar.gz(r-4.6-any)
lczexplore_0.1.1.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
lczexplore/json (API)

# Install 'lczexplore' in R:
install.packages('lczexplore', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org'))
Datasets:

On CRAN:

Conda:

This package does not link to any Github/Gitlab/R-forge repository. No issue tracker or development information is available.

3.40 score 10 scripts 53 exports 70 dependencies

Last updated from:8e6b6e6c96. Checks:6 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-develOK279
source / vignettesOK290
linux-releaseOK291
windows-develOK260
windows-releaseOK331
wasm-releaseOK159

Exports:addMissingRSUsaggregateRSUsByLCZareColorsbarplotLCZaLocationbarplotLCZfromIntersectcheckColnameCasecheckDirSlashcheckWorkflowNameCohenKappacompareLCZcompareMultipleLCZcompleteDTcomputeConsensusconcatAllLocsWorkflowsconcatAlocationWorkflowsconcatIntersectedLocationsconfidSensibcreateIntersectcreateWeightedFluxdrawChordDiagramdrawChordDiagramWithGroupingdrawSectorsfetchLCZgeoClimateCallgeoClimateConfigFilegroupLCZgroupLCZsuffiximportConcatMultipleLocsLCZvectimportLCZgcimportLCZrasterimportLCZvectimportLCZvectFromFileimportLCZvectFromSfimportMultipleLCZvectimportMultipleLCZvectFromSessionimportMultipleLocsLCZvectimportQualVarintersectAlocationLCZareasLCZlevelToOrderedStringlevColmakeSectorsAndGroupsmatConfLCZmatConfLCZGlobmatConfPlotplotSankeyfiedLCZplotSummarisedRSUsprepareSankeyLCZshowLCZshowStandardLCZstandLevColsummariseRSUsworkflowAgreeAreas

Dependencies:abindcirclizeclassclassIntcliclustercollapsecolorspacecpp11crayoncurldata.tableDBIdplyre1071farverforcatsgenericsggnewscaleggplot2ggsankeyfierggspatialGlobalOptionsgluegridBeziergtablehmsisobandjpegjsonliteKernSmoothlabelinglifecyclemagrittrpatchworkpillarpkgconfigpngpolyclipprettyunitsprogressproxypurrrR6randomcoloRRColorBrewerRcpprlangrosmRtsnes2S7scalessfshadesshapestringistringrterratibbletidyrtidyselectunitsutf8V8vctrsviridisLitevwlinewithrwk

lczexplore_alter
Short introduction to lczexplore | Grouping levels and exploring the resulting broader categories | From original data... | ... to grouped levels | Compare two LCZ classification with the function compareLCZ and the alter representation | Most common case | Levels specified but colors unspecified | Colors specified, but not levels | Case when some of the specified colors are not actually colors | Case when provided vectors of levels and colors don't cover the levels of the data | A trick to group and compare/show all at once
Rendered fromlczexplore_alter.Rmdusingknitr::rmarkdown

Last update: 2026-10-28
Started: 2026-10-28

lczexplore_en
A package to explore Local Climate Zones: lczexplore | Purpose and origin | Installation | First use-case: load a file with geometries and standard LCZ | Import files with importLCZvect function | Map the LCZ types with the function showLCZ | Standard representation | Alternative visualization | Group several LCZ types in a category using groupLCZ | Compare two LCZ classification with the function compareLCZ | Output data for further analysis | Sensitivity of the agreement to the confidence value | Import the necessary data: LCZ type, but also confidence.
Rendered fromlczexplore_en.Rmdusingknitr::rmarkdown

Last update: 2026-10-28
Started: 2026-10-28

lczexplore_fr
Présentation du paquet lczexplore | Origine et finalité | Installation | Cas général : charger un fichier contenant des géométries et les LCZ associées | Importer les fichiers contenant les LCZ avec la fonction importLCZvect | Représenter les LCZ avec la fonction showLCZ | Représentation standard | Représentation alternative | Regrouper des types de LCZ avec la fonction groupLCZ | Comparer deux classifications LCZ avec la fonction compareLCZ | Représentations graphiques | Données produites et analyses ultérieures | Etude de la sensibilité de l'accord à la confiance accordée aux valeurs de LCZ | Prise en compte des géométries et des valeurs de confiance lors de l'import des fichiers.
Rendered fromlczexplore_fr.Rmdusingknitr::rmarkdown

Last update: 2026-10-28
Started: 2026-10-28

lczexplore_multiple_workflows
Context and vocabulary | Local Climate Zones | Spatial Units | Data preparation for multiple workflows and multiple study areas | Input data structure | General steps to compare several LCZ maps | Importing maps from several locations and several workflows | Intersecting geometries from the different workflows | Visualizing the data | Reminder: visualize a single map | Reminder: comparing two simple maps | Area per LCZ type and workflow for more than 2 workflows | Compare multiple workflows | Pairwise agreements | Repartition from one workflow to another and data visualisations | A very specific case of missing geometries
Rendered fromlczexplore_multiple_workflows.Rmdusingknitr::rmarkdown

Last update: 2026-10-28
Started: 2026-10-28

Raster_vector_comparison
Import and visualize a raster map of LCZ | Data: the Redon territory from the european LCZ map produced by the WUDAPT project | Load a territory from a raster map and a bounding box | Visualize the LCZ map with the function showLCZ | Import and visualize a vector layer map of LCZ | Data: LCZ on the Redon territory produced by the GeoClimate workflow using OpenStreetMap as input. | Visualize the resulting LCZ types with the function showLCZ | Comparison of the two LCZ classification | Grouping some levels and comparing the grouped categories
Rendered fromlczexplore_raster_vector.Rmdusingknitr::rmarkdown

Last update: 2026-10-28
Started: 2026-10-28

Readme and manuals

Help Manual

Help pageTopics
adds missing Reference Spatial Units (geometries) from the difference with a reference zone file, and possibly add a value to the lcz column according to a reference workflow reference spatial units nor represented by their own geometries adding a column for location and workflow namesaddMissingRSUs
For an sf object containing LCZ types, aggregates touching geometries with same value of LCZaggregateRSUsByLCZ
Checks if a string or a vector of strings define colors in RareColors
in a given directory, if several LCZ files are present, plots the repartition of LCZ regarding of their source (workflow) NOTE: to represent the map of LCZ for a given file, use 'showLCZ' function insteadbarplotLCZaLocation
plots the repartition of LCZ types regarding of their source (map/workflow) from an sf object containing all spatial units and LCZ value, typically the output of createIntersectbarplotLCZfromIntersect
Checks if the columns entered by the user match the columns in the data sourcecheckColnameCase
Simply adds a slash at then end of a directory path if there is nonecheckDirSlash
Checks if a character string can be used as a workflow name and corrects it if it contains spaces or underscorescheckWorkflowName
Compute Cohen's Kappa CoefficientCohenKappa
Compares two sets of geographical classifications, especially Local Climate Zones classificationscompareLCZ
Compares several sets of geographical classifications, especially Local Climate Zones classificationscompareMultipleLCZ
creates a complete data.table from the cross cases of the specified columnscompleteDT
compute agreements between several LCZ mapscomputeAgreements
Compute an indicator of consensus among workflows for each LCZ typecomputeConsensus
importConcatMultipleLocsLCZvect is recommended instead as it loadsand concatenate input files and can even fill missing geometries with "unclassified" type. But if maps are already loaded in a List, concatAllLocsWorkflows is the equivalent of concatenateAlocationWorkflows, but for several Locations Take a list of locations, each list contains a list of sf files with an lcz_primary column, and concatenates them into a single sf object, adding a column for location and workflow namesconcatAllLocsWorkflows
Take a list of sf files with lcz_primary and wf columns, and concatenates them in a single sf object, adding a column for location and workflow namesconcatAlocationWorkflows
In a given directory (or a list of directories) the function looks for LCZ datafiles, intersects them and return a dataset with intersected geometries and LCZ values for each workflowconcatIntersectedLocations
Computes the agreement between geographical (LCZ) classifications on a range of values of an indicator of confidence granted to each LCZ classification. The input file or dataset must have been produced by compareLCZ function, or at least the columns must be in the same orderconfidSensib
Intersects multiple sf files in which Local Climate Zones are set for polygon geometriescreateIntersect
Takes an sf object with several workflow values, and creates all pairwise confusion matrices, then conatenates them in long form, usable to plot chord diagramscreateWeightedFlux
Draws how LCZ types from several workflows break up into LCZ types of one anotherdrawChordDiagram
Draws how LCZ types from several workflows break up into LCZ types of one another when some grouping is precised in the argumentsdrawChordDiagramWithGrouping
Draws sectors and groups inside the drawChordDiagram functiondrawSectors
Deprecated DO NOT USE, kept in case some users might need it Fetches LCZ classification data, by default from the Geomanum cloud, for locations already uploaded there by the Geoclimate teamfetchLCZ
Calls GeoClimate jar file and feeds it a configuration file by building a command an using system (only tested on linux)geoClimateCall
Builds a JSON configuration file for GeoClimate workflow.geoClimateConfigFile
Allows to group (Local Climate Zone) geographical classification levels into broader categories to explore classification agreementsgroupLCZ
Regroups levels of origin and destination of a multiple confusion matrix in long form.groupLCZsuffix
In a given list of directories the function looks for LCZ datafiles, return a datasets LCZ values for each geom and workflowimportConcatMultipleLocsLCZvect
Imports the wf_lcz fgb file produced by GeoClimate. Not recommended. Use the more generic importLCZvect functionimportLCZgc
Imports the LCZ classifications produced on raster maps. For now, the european tif map produced by WUDAP is used as a reference example. Users can DOWNLOAD the WUDAPT tif file at the following url : https://figshare.com/articles/dataset/European_LCZ_map/13322450importLCZraster
Imports Local Climate Zone classifications from a vector source, a geographical file or an sf object from the current R sessionimportLCZvect
Imports Local Climate Zone classifications from a standard geographical file (tested : geojson, shp, more to come)importLCZvectFromFile
Imports Local Climate Zone classifications from an existing sf objectimportLCZvectFromSf
In a given directory (or a list of directories) the function looks for LCZ datafiles and load them in a list. In each directory, files must have names built as follow : wf_lcz.fileExtension, where wf are the values specified in workflowNames parameter and fileExtension is a file extension known by sf drivers, like fgb, geojson...importMultipleLCZvect
Take a list of sf objects within the session and format them to allow the use of createIntersect and multipleCompare functions.importMultipleLCZvectFromSession
In a given directory the function looks different locations as subdirectories and LCZ datafiles in each subdirectory, and load them in a list In each directory, files must have names built as follow : wf_lcz.fileExtension, where wf are the values specified in workflowNames parameter and fileExtension is a file extension known by sf drivers, like fgb, geojson...importMultipleLocsLCZvect
Imports a qualitative variable associated with polygons from a geographical dataset (tested : geojson, shp, more to come)importQualVar
DEPRECATED: use concatIntersectedLocations with the proper arguments Intersects several sf files for a given location identified by a given directory path and nameintersectAlocation
Computes the area of each level of a LCZLCZareas
To make LCZ types appear in the proper order, it can be useful ton convert them into strings with added zerosLCZlevelToOrderedString
Manages the levels and the colors of the LCZ columnslevCol
Creates sectors and groups for the drawChordDiagram functionmakeSectorsAndGroups
Produces a confusion matrix between two sets of lcz on the same area (geoms do not need to be the same)matConfLCZ
Compares two LCZ classifications on several locationsmatConfLCZGlob
Plots a tile graph of a confusion matrix between two sets of lcz on the same areamatConfPlot
Plots a sankey graph between two LCZ workflowsplotSankeyfiedLCZ
For a given LCZ sf object, plots the number of geometries and an average area indicator per level of LCZplotSummarisedRSUs
Prepares the data to produce a sankey graph between two LCZ workflowsprepareSankeyLCZ
RedonBDTredonBDT
RedonOSMredonOSM
Produces a simple representation of the LCZ contained in an sf file with non standard LCZ type encodingshowAlterLCZ
Produces a simple representation of the LCZ contained in an sf fileshowLCZ
Produces a simple representation of the LCZ contained in an sf file when standard LCZ type format is usedshowStandardLCZ
Detects standard LCZ levels and associate standard colors to themstandLevCol
For a given LCZ sf object, returns the number of geometries and their mean area per LCZ typesummariseRSUs
From the output of compare multiple, cmputes which workflows agree the most regarding the area of agreementworkflowAgreeAreas