LCZ4r

An R Package for Local Climate Zones and Urban Heat Island Analysis.
https://github.com/bymaxanjos/lcz4r

Category: Climate Change
Sub Category: Earth and Climate Modeling

Last synced: about 13 hours ago
JSON representation

Repository metadata

An R Package for Local Climate Zones and Urban Heat Island Analysis

README-en.md

Tools for Local Climate Zone and Urban Heat Island Analysis in R

Lifecycle: experimental

The LCZ4r package provides a comprehensive suite of tools for analyzing and visualizing Local Climate Zones (LCZ) and Urban Heat Islands (UHI) in R. Designed for researchers, urban planners, and climate scientists, LCZ4r simplifies the process of downloading, processing, and interpreting LCZ data.


1. Installation

The LCZ4r package is available on GitHub and can be installed in two ways.
We recommend Option 1 for most users.


Option 1: Install from GitHub (Recommended)

This is the fastest way to get the latest version of the package.

::: callout-tip
Prerequisite: If you already have remotes or devtools installed, you can skip this step.
:::

if (!require("remotes")) { install.packages("remotes")}
# Install or update directly from GitHub
remotes::install_github("ByMaxAnjos/LCZ4r", upgrade = "never")

::: callout-warning
Updates: LCZ4r is under active development. To update, simply run the command above again.
R will automatically overwrite the previous version. After updating, it is recommended to restart your R session
(Session > Restart R).
:::

Option 2: Install from Local File (.zip)

This option is recommended for: unstable internet connections, restricted networks (e.g., institutional environments), and training sessions with multiple users.

Steps:

  1. Download the package
    👉 https://github.com/ByMaxAnjos/LCZ4r/archive/refs/heads/main.zip

  2. Extract the file
    👉 After downloading, extract the .zip file to a local folder (e.g., Downloads or Desktop)

  3. Install locally

# IMPORTANT: Adjust the path to where you extracted the folder
remotes::install_local(
  "C:/Path/to/your/folder/LCZ4r-main", 
  upgrade = "never"
)

::: callout-tip
Example: If you downloaded and extracted the file to your Downloads folder:

remotes::install_local(
   "/Users/maxanjos/Downloads/LCZ4r-main",
  upgrade = "never"
)

:::

Loading the package

After installation, load the package whenever you start a new R session:

library(LCZ4r)

Run LCZ4r in Posit Cloud, no RStudio installation required!


LCZ4r-QGIS Plugin: Multilingual Integration

The LCZ4r-QGIS plugin integrates the LCZ4r package with QGIS, enabling users to analyze Local Climate Zones and urban heat islands directly within the QGIS environment. The plugin supports multiple languages, making it accessible to a global audience.


Inspiration

The LCZ4r package is inspired by the following works:


Have Feedback or Suggestions?

We value your input! If you have ideas for improvement or spot any issues, please let us know by opening an issue on GitHub.


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 4 days ago

Total Commits: 441
Total Committers: 2
Avg Commits per committer: 220.5
Development Distribution Score (DDS): 0.002

Commits in past year: 75
Committers in past year: 1
Avg Commits per committer in past year: 75.0
Development Distribution Score (DDS) in past year: 0.0

Name Email Commits
Max Anjos m****s@c****t 440
DayvidCMedeiros 1****s 1

Committer domains:


Issue and Pull Request metadata

Last synced: 9 months ago

Total issues: 2
Total pull requests: 1
Average time to close issues: 43 minutes
Average time to close pull requests: 3 minutes
Total issue authors: 2
Total pull request authors: 1
Average comments per issue: 1.0
Average comments per pull request: 1.0
Merged pull request: 1
Bot issues: 0
Bot pull requests: 0

Past year issues: 2
Past year pull requests: 0
Past year average time to close issues: 43 minutes
Past year average time to close pull requests: N/A
Past year issue authors: 2
Past year pull request authors: 0
Past year average comments per issue: 1.0
Past year average comments per pull request: 0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/bymaxanjos/lcz4r

Top Issue Authors

  • ByMaxAnjos (1)
  • Rapsodia86 (1)

Top Pull Request Authors

  • DayvidCMedeiros (1)

Top Issue Labels

Top Pull Request Labels


Dependencies

DESCRIPTION cran

Score: 3.828641396489095