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

Documentation for package ‘lczexplore’ version 0.1.1

Help Pages

addMissingRSUs	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 names
aggregateRSUsByLCZ	For an sf object containing LCZ types, aggregates touching geometries with same value of LCZ
areColors	Checks if a string or a vector of strings define colors in R
barplotLCZaLocation	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 instead
barplotLCZfromIntersect	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 createIntersect
checkColnameCase	Checks if the columns entered by the user match the columns in the data source
checkDirSlash	Simply adds a slash at then end of a directory path if there is none
checkWorkflowName	Checks if a character string can be used as a workflow name and corrects it if it contains spaces or underscores
CohenKappa	Compute Cohen's Kappa Coefficient
compareLCZ	Compares two sets of geographical classifications, especially Local Climate Zones classifications
compareMultipleLCZ	Compares several sets of geographical classifications, especially Local Climate Zones classifications
completeDT	creates a complete data.table from the cross cases of the specified columns
computeAgreements	compute agreements between several LCZ maps
computeConsensus	Compute an indicator of consensus among workflows for each LCZ type
concatAllLocsWorkflows	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 names
concatAlocationWorkflows	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 names
concatIntersectedLocations	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 workflow
confidSensib	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 order
createIntersect	Intersects multiple sf files in which Local Climate Zones are set for polygon geometries
createWeightedFlux	Takes an sf object with several workflow values, and creates all pairwise confusion matrices, then conatenates them in long form, usable to plot chord diagrams
drawChordDiagram	Draws how LCZ types from several workflows break up into LCZ types of one another
drawChordDiagramWithGrouping	Draws how LCZ types from several workflows break up into LCZ types of one another when some grouping is precised in the arguments
drawSectors	Draws sectors and groups inside the drawChordDiagram function
fetchLCZ	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 team
geoClimateCall	Calls GeoClimate jar file and feeds it a configuration file by building a command an using system (only tested on linux)
geoClimateConfigFile	Builds a JSON configuration file for GeoClimate workflow.
groupLCZ	Allows to group (Local Climate Zone) geographical classification levels into broader categories to explore classification agreements
groupLCZsuffix	Regroups levels of origin and destination of a multiple confusion matrix in long form.
importConcatMultipleLocsLCZvect	In a given list of directories the function looks for LCZ datafiles, return a datasets LCZ values for each geom and workflow
importLCZgc	Imports the wf_lcz fgb file produced by GeoClimate. Not recommended. Use the more generic importLCZvect function
importLCZraster	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/13322450
importLCZvect	Imports Local Climate Zone classifications from a vector source, a geographical file or an sf object from the current R session
importLCZvectFromFile	Imports Local Climate Zone classifications from a standard geographical file (tested : geojson, shp, more to come)
importLCZvectFromSf	Imports Local Climate Zone classifications from an existing sf object
importMultipleLCZvect	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...
importMultipleLCZvectFromSession	Take a list of sf objects within the session and format them to allow the use of createIntersect and multipleCompare functions.
importMultipleLocsLCZvect	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...
importQualVar	Imports a qualitative variable associated with polygons from a geographical dataset (tested : geojson, shp, more to come)
intersectAlocation	DEPRECATED: use concatIntersectedLocations with the proper arguments Intersects several sf files for a given location identified by a given directory path and name
LCZareas	Computes the area of each level of a LCZ
LCZlevelToOrderedString	To make LCZ types appear in the proper order, it can be useful ton convert them into strings with added zeros
levCol	Manages the levels and the colors of the LCZ columns
makeSectorsAndGroups	Creates sectors and groups for the drawChordDiagram function
matConfLCZ	Produces a confusion matrix between two sets of lcz on the same area (geoms do not need to be the same)
matConfLCZGlob	Compares two LCZ classifications on several locations
matConfPlot	Plots a tile graph of a confusion matrix between two sets of lcz on the same area
plotSankeyfiedLCZ	Plots a sankey graph between two LCZ workflows
plotSummarisedRSUs	For a given LCZ sf object, plots the number of geometries and an average area indicator per level of LCZ
prepareSankeyLCZ	Prepares the data to produce a sankey graph between two LCZ workflows
redonBDT	RedonBDT
redonOSM	RedonOSM
showAlterLCZ	Produces a simple representation of the LCZ contained in an sf file with non standard LCZ type encoding
showLCZ	Produces a simple representation of the LCZ contained in an sf file
showStandardLCZ	Produces a simple representation of the LCZ contained in an sf file when standard LCZ type format is used
standLevCol	Detects standard LCZ levels and associate standard colors to them
summariseRSUs	For a given LCZ sf object, returns the number of geometries and their mean area per LCZ type
workflowAgreeAreas	From the output of compare multiple, cmputes which workflows agree the most regarding the area of agreement