lczexplore

lczexplore: an R package to explore Local Climate Zone classifications - Published in JOSS (2023)

https://github.com/orbisgis/lczexplore

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 2 DOI reference(s) in README and JOSS metadata
○
Academic publication links
✓
Committers with academic emails
1 of 4 committers (25.0%) from academic institutions
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Keywords

climate-change environment geoclimate r-spatial

Last synced: 6 months ago · JSON representation ·

Repository

Basic Info

Host: GitHub
Owner: orbisgis
License: lgpl-3.0
Language: R
Default Branch: master
Homepage:
Size: 18.6 MB

Statistics

Stars: 5
Watchers: 1
Forks: 4
Open Issues: 0
Releases: 0

Topics

climate-change environment geoclimate r-spatial

Created about 3 years ago · Last pushed 10 months ago

Metadata Files

Readme Contributing License Code of conduct Citation

README.md

metadata title="lczexplore : a package to compare Local Climate Zone classifications"

output: github_document

lczexplore

This is the 0.0.1.0000 version of the package lczexplore.

Licence

The code of this package is under the LGPL-3 licence as described in https://www.r-project.org/Licenses/LGPL-3

Fundings

The lczexplore library has been originally developed within the following research projects: * PAENDORA2 (Pour la gestion du confort estival : Donnees, Outils et Recherche-Action) (2022 -2025), funded by ADEME

Reference paper

lczexplore is described in the following paper :

Matthieu Gousseff, Erwan Bocher, Jérémy Bernard, Elisabeth Le Saux Wiederhold. lczexplore: an R package to explore Local Climate Zone classifications. Journal of Open Source Software, 2023, 8 (91), pp.5445. ⟨10.21105/joss.05445⟩. ⟨halshs-04293878⟩

Citation

If you are kind enough to cite this package, please check in the /inst directory for the CITATION file (in cff style without the extension)

Installation

This package can be installed from github using the installgithub function of the devtools package. ```R library(devtools) devtools::installgithub("orbisgis/lczexplore") It can also be installed from the tarball file.R install.packages("/path/lczexplore_0.0.1.0000.tar.gz ",repos=NULL)

``` where path is the folder where you download the tarball sources.

Summary

The goal of lczexplore is to explore and compare Local Climate Zone classifications of urban areas.

Climate change is a growing concern for city planners with a special focus on Urban Heat Island phenomenons. Stewardt and Oke [ref] have proposed a classification of Local Climate Zones (LCZ) that describe rural and urban areas, with 10 built types and 7 land cover types.

Several approaches classify land units into LCZ and may produce different results. For instance, the GeoClimate geospatial toolbox use GIS layers from OpenStreetMap or the french BD Topo whereas the WUDAPT platform uses remotely sensed information and local expert knowledge.

The lczexplore packages allows to easily : - load these classification from GIS layers - produce maps of these LCZ classification - compare these classifications

Comparison of LCZ classifications

In order to compare two LCZ classifications the compareLCZ function proceeds the following steps :

Plot the two classifications

Two maps are produced and allow a visual comparison of the two classifications.

Interesect the geometries of both classifications

This steps returns geometries on which the two classifications either totally agree either totally disagree, and plot them on a map.

Quantify the agreement

The areas of all the geometries where the classifications agree are summed and give the general percentage of agreement.

Qualify the disagreement

A confusion matrix shows how a given level of LCZ for the first classification is broken down into the levels of the other classification.

Comparison result for twho workflows on Redon data

Sensibility analysis

Some LCZ classifications come with a confidence level for each spatial unit. For instance, the GeoClimate toolbox sets a LCZ level to a spatial unit according to the values of urban canopy parameters, and computes a uniqueness value that indicates if other levels of LCZ could also have been set to this spatial unit. This uniqueness value can be seen as a confidence measurement of the LCZ level.

The lczexplore package allows to see how this confidence value impacts the general agreement between two LCZ classification.

Main functions

The following functions are the core of this package : importLCZvect : imports the LCZ layer from a GIS (tested with geojson and shapefile files) importLCZwudapt : imports LCZ from the wudapt Europe Tiff. You'll have to use importLCZvect first to create the Bounding box of your zone of interest showLCZ : plots the map of your LCZ compareLCZ : compares two LCZ classifications of the same areas, output plots and data if this comparison confidSensib : explores how the agreement between two LCZ varies according to a confidence indicator associated for the LCZ value of each geom (sensibility analysis) Sensibiilty analysis : how the confidence we have in LCZ classifications impacts the agreement betweend classifications

Other (experimental) functions

These functions are used in the PAENDORA 2 project but may not be generic enough or robust enough for other uses. groupLCZ : allows to group some LCZ levels into a level named by the user (for instance to group all compact LCZ, or all vegetation LCZ...) fetchLCZ : allows the download and unzip of LCZ files. The user can specify the URL where the function should seek the data.

Owner

Name: OrbisGIS
Login: orbisgis
Kind: organization
Location: Vannes

Website: http://www.orbisgis.org
Repositories: 51
Profile: https://github.com/orbisgis

A GIS platform and components developed by the CNRS

JOSS Publication

lczexplore: an R package to explore Local Climate Zone classifications

Published

November 15, 2023

DOI

10.21105/joss.05445

Volume 8, Issue 91, Page 5445

Authors

Matthieu Gousseff

CNRS, Lab-STICC, UMR 6285, Vannes, France

Erwan Bocher

CNRS, Lab-STICC, UMR 6285, Vannes, France

Jérémy Bernard

CNRS, Lab-STICC, UMR 6285, Vannes, France, University of Savoie Mont-Blanc, LOCIE, UMR 5271, France, University of Gothenburg, Department of Earth Sciences, Sweden

Elisabeth Le Saux Wiederhold

Université Bretagne Sud, Lab-STICC, UMR 6285, Vannes, France

Editor

Martin Fleischmann

Citation (CITATION.cff)

# -----------------------------------------------------------
# CITATION file created with {cffr} R package, v0.4.1
# See also: https://docs.ropensci.org/cffr/
# -----------------------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "lczexplore" in publications use:'
type: software
license: LGPL-3.0-only
title: 'lczexplore: lczexplore'
version: 0.0.1.0000
abstract: 'This lczexplore package automatize the comparison of sets of local climate
  zones.It was developped thanks to the project PAENDORA2 (Pour la gestion du confort
  estival : Données, Outils et Recherche-Action) (2022 -2025), funded by ADEME'
authors:
- family-names: Gousseff
  given-names: Matthieu
  email: matthieu.gousseff@univ-ubs.fr
contact:
- family-names: Gousseff
  given-names: Matthieu
  email: matthieu.gousseff@univ-ubs.fr
references:
- type: software
  title: RColorBrewer
  abstract: 'RColorBrewer: ColorBrewer Palettes'
  notes: Imports
  repository: https://CRAN.R-project.org/package=RColorBrewer
  authors:
  - family-names: Neuwirth
    given-names: Erich
    email: erich.neuwirth@univie.ac.at
  year: '2023'
- type: software
  title: cowplot
  abstract: 'cowplot: Streamlined Plot Theme and Plot Annotations for ''ggplot2'''
  notes: Imports
  url: https://wilkelab.org/cowplot/
  repository: https://CRAN.R-project.org/package=cowplot
  authors:
  - family-names: Wilke
    given-names: Claus O.
    email: wilke@austin.utexas.edu
    orcid: https://orcid.org/0000-0002-7470-9261
  year: '2023'
- type: software
  title: dplyr
  abstract: 'dplyr: A Grammar of Data Manipulation'
  notes: Imports
  url: https://dplyr.tidyverse.org
  repository: https://CRAN.R-project.org/package=dplyr
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
    orcid: https://orcid.org/0000-0003-4757-117X
  - family-names: François
    given-names: Romain
    orcid: https://orcid.org/0000-0002-2444-4226
  - family-names: Henry
    given-names: Lionel
  - family-names: Müller
    given-names: Kirill
    orcid: https://orcid.org/0000-0002-1416-3412
  - family-names: Vaughan
    given-names: Davis
    email: davis@posit.co
    orcid: https://orcid.org/0000-0003-4777-038X
  year: '2023'
- type: software
  title: forcats
  abstract: 'forcats: Tools for Working with Categorical Variables (Factors)'
  notes: Imports
  url: https://forcats.tidyverse.org/
  repository: https://CRAN.R-project.org/package=forcats
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@rstudio.com
  year: '2023'
- type: software
  title: ggplot2
  abstract: 'ggplot2: Create Elegant Data Visualisations Using the Grammar of Graphics'
  notes: Imports
  url: https://ggplot2.tidyverse.org
  repository: https://CRAN.R-project.org/package=ggplot2
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@rstudio.com
    orcid: https://orcid.org/0000-0003-4757-117X
  - family-names: Chang
    given-names: Winston
    orcid: https://orcid.org/0000-0002-1576-2126
  - family-names: Henry
    given-names: Lionel
  - family-names: Pedersen
    given-names: Thomas Lin
    email: thomas.pedersen@rstudio.com
    orcid: https://orcid.org/0000-0002-5147-4711
  - family-names: Takahashi
    given-names: Kohske
  - family-names: Wilke
    given-names: Claus
    orcid: https://orcid.org/0000-0002-7470-9261
  - family-names: Woo
    given-names: Kara
    orcid: https://orcid.org/0000-0002-5125-4188
  - family-names: Yutani
    given-names: Hiroaki
    orcid: https://orcid.org/0000-0002-3385-7233
  - family-names: Dunnington
    given-names: Dewey
    orcid: https://orcid.org/0000-0002-9415-4582
  year: '2023'
- type: software
  title: magrittr
  abstract: 'magrittr: A Forward-Pipe Operator for R'
  notes: Imports
  url: https://magrittr.tidyverse.org
  repository: https://CRAN.R-project.org/package=magrittr
  authors:
  - family-names: Bache
    given-names: Stefan Milton
    email: stefan@stefanbache.dk
  - family-names: Wickham
    given-names: Hadley
    email: hadley@rstudio.com
  year: '2023'
- type: software
  title: sf
  abstract: 'sf: Simple Features for R'
  notes: Imports
  url: https://r-spatial.github.io/sf/
  repository: https://CRAN.R-project.org/package=sf
  authors:
  - family-names: Pebesma
    given-names: Edzer
    email: edzer.pebesma@uni-muenster.de
    orcid: https://orcid.org/0000-0001-8049-7069
  year: '2023'
- type: software
  title: terra
  abstract: 'terra: Spatial Data Analysis'
  notes: Imports
  url: https://rspatial.org/terra/
  repository: https://CRAN.R-project.org/package=terra
  authors:
  - family-names: Hijmans
    given-names: Robert J.
    email: r.hijmans@gmail.com
    orcid: https://orcid.org/0000-0001-5872-2872
  year: '2023'
- type: software
  title: tidyr
  abstract: 'tidyr: Tidy Messy Data'
  notes: Imports
  url: https://tidyr.tidyverse.org
  repository: https://CRAN.R-project.org/package=tidyr
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
  - family-names: Vaughan
    given-names: Davis
    email: davis@posit.co
  - family-names: Girlich
    given-names: Maximilian
  year: '2023'
- type: software
  title: units
  abstract: 'units: Measurement Units for R Vectors'
  notes: Imports
  url: https://github.com/r-quantities/units
  repository: https://CRAN.R-project.org/package=units
  authors:
  - family-names: Pebesma
    given-names: Edzer
    email: edzer.pebesma@uni-muenster.de
    orcid: https://orcid.org/0000-0001-8049-7069
  - family-names: Mailund
    given-names: Thomas
    email: mailund@birc.au.dk
  - family-names: Kalinowski
    given-names: Tomasz
  - family-names: Ucar
    given-names: Iñaki
    email: iucar@fedoraproject.org
    orcid: https://orcid.org/0000-0001-6403-5550
  year: '2023'
- type: software
  title: rlang
  abstract: 'rlang: Functions for Base Types and Core R and ''Tidyverse'' Features'
  notes: Imports
  url: https://rlang.r-lib.org
  repository: https://CRAN.R-project.org/package=rlang
  authors:
  - family-names: Henry
    given-names: Lionel
    email: lionel@rstudio.com
  - family-names: Wickham
    given-names: Hadley
    email: hadley@rstudio.com
  year: '2023'
- type: software
  title: grDevices
  abstract: 'R: A Language and Environment for Statistical Computing'
  notes: Imports
  authors:
  - name: R Core Team
  location:
    name: Vienna, Austria
  year: '2023'
  institution:
    name: R Foundation for Statistical Computing
- type: software
  title: methods
  abstract: 'R: A Language and Environment for Statistical Computing'
  notes: Imports
  authors:
  - name: R Core Team
  location:
    name: Vienna, Austria
  year: '2023'
  institution:
    name: R Foundation for Statistical Computing
- type: software
  title: tinytest
  abstract: 'tinytest: Lightweight and Feature Complete Unit Testing Framework'
  notes: Suggests
  url: https://github.com/markvanderloo/tinytest
  repository: https://CRAN.R-project.org/package=tinytest
  authors:
  - family-names: van der Loo
    given-names: Mark
    email: mark.vanderloo@gmail.com
    orcid: https://orcid.org/0000-0002-9807-4686
  year: '2023'
- type: software
  title: knitr
  abstract: 'knitr: A General-Purpose Package for Dynamic Report Generation in R'
  notes: Suggests
  url: https://yihui.org/knitr/
  repository: https://CRAN.R-project.org/package=knitr
  authors:
  - family-names: Xie
    given-names: Yihui
    email: xie@yihui.name
    orcid: https://orcid.org/0000-0003-0645-5666
  year: '2023'
- type: software
  title: rmarkdown
  abstract: 'rmarkdown: Dynamic Documents for R'
  notes: Suggests
  url: https://pkgs.rstudio.com/rmarkdown/
  repository: https://CRAN.R-project.org/package=rmarkdown
  authors:
  - family-names: Allaire
    given-names: JJ
    email: jj@rstudio.com
  - family-names: Xie
    given-names: Yihui
    email: xie@yihui.name
    orcid: https://orcid.org/0000-0003-0645-5666
  - family-names: McPherson
    given-names: Jonathan
    email: jonathan@rstudio.com
  - family-names: Luraschi
    given-names: Javier
    email: javier@rstudio.com
  - family-names: Ushey
    given-names: Kevin
    email: kevin@rstudio.com
  - family-names: Atkins
    given-names: Aron
    email: aron@rstudio.com
  - family-names: Wickham
    given-names: Hadley
    email: hadley@rstudio.com
  - family-names: Cheng
    given-names: Joe
    email: joe@rstudio.com
  - family-names: Chang
    given-names: Winston
    email: winston@rstudio.com
  - family-names: Iannone
    given-names: Richard
    email: rich@rstudio.com
    orcid: https://orcid.org/0000-0003-3925-190X
  year: '2023'
- type: software
  title: testthat
  abstract: 'testthat: Unit Testing for R'
  notes: Suggests
  url: https://testthat.r-lib.org
  repository: https://CRAN.R-project.org/package=testthat
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@rstudio.com
  year: '2023'
  version: '>= 3.0.0'
- type: software
  title: 'R: A Language and Environment for Statistical Computing'
  notes: Depends
  url: https://www.R-project.org/
  authors:
  - name: R Core Team
  location:
    name: Vienna, Austria
  year: '2023'
  institution:
    name: R Foundation for Statistical Computing
  version: '>= 2.10'

GitHub Events

Total

Delete event: 1
Push event: 10
Pull request event: 7

Last Year

Delete event: 1
Push event: 10
Pull request event: 7

Committers

Last synced: 7 months ago

All Time

Total Commits: 197
Total Committers: 4
Avg Commits per committer: 49.25
Development Distribution Score (DDS): 0.036

Past Year

Commits: 53
Committers: 1
Avg Commits per committer: 53.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
MGousseff	m**f@g**m	190
Bocher	e**r@u**r	4
Martin Fleischmann	m**n@m**t	2
Olivia Guest	o****t	1

Committer Domains (Top 20 + Academic)

martinfleischmann.net: 1 univ-ubs.fr: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 5
Total pull requests: 32
Average time to close issues: 3 months
Average time to close pull requests: 6 days
Total issue authors: 1
Total pull request authors: 4
Average comments per issue: 1.2
Average comments per pull request: 0.16
Merged pull requests: 32
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 5
Average time to close issues: N/A
Average time to close pull requests: 6 minutes
Issue authors: 0
Pull request authors: 1
Average comments per issue: 0
Average comments per pull request: 0.0
Merged pull requests: 5
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

wcjochem (4)

Pull Request Authors

MGousseff (31)
martinfleis (1)
oliviaguest (1)
ebocher (1)

Top Labels

Issue Labels

Pull Request Labels

Dependencies

.github/workflows/draft-pdf.yml actions

actions/checkout v2 composite
actions/upload-artifact v1 composite
openjournals/openjournals-draft-action master composite

DESCRIPTION cran

R >= 2.10 depends
DescTools * imports
RColorBrewer * imports
cowplot * imports
dplyr * imports
forcats * imports
ggplot2 * imports
grDevices * imports
magrittr * imports
methods * imports
rlang * imports
sf * imports
terra * imports
tidyr * imports
units * imports
knitr * suggests
png * suggests
rmarkdown * suggests
testthat >= 3.0.0 suggests
tinytest * suggests

lczexplore

Science Score: 100.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

output: github_document

lczexplore

Licence

Fundings

Reference paper

Citation

Installation

Summary

Comparison of LCZ classifications

Plot the two classifications

Interesect the geometries of both classifications

Quantify the agreement

Qualify the disagreement

Sensibility analysis

Main functions

Other (experimental) functions

Owner

JOSS Publication

lczexplore: an R package to explore Local Climate Zone classifications

Authors

Editor

Tags

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Dependencies