kuenm2

Make the process of ecological niche modeling easier, faster, and more reproducible, and at the same time more robust.
https://github.com/marlonecobos/kuenm2

Category: Biosphere
Sub Category: Species Distribution Modeling

Last synced: about 22 hours ago
JSON representation

Repository metadata

Repository for the new major version of kuenm

• Host: GitHub
• URL: https://github.com/marlonecobos/kuenm2
• Owner: marlonecobos
• Created: 2022-09-30T16:17:06.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2026-04-07T14:40:19.000Z (14 days ago)
• Last Synced: 2026-04-16T01:02:27.112Z (6 days ago)
• Language: R
• Homepage: https://marlonecobos.github.io/kuenm2/
• Size: 37.7 MB
• Stars: 11
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Releases: 1
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md

README.Rmd

          ---
title: "kuenm2: Detailed Development of Ecological Niche Models"
author: "Weverton C. F. Trindade, Luis F. Arias-Giraldo, Luis Osorio-Olvera, A. Townsend Peterson, and Marlon E. Cobos "
output: 
  github_document:
    toc: yes
    toc_depth: 3
always_allow_html: true
---

```{r knitr_init, echo=FALSE, cache=FALSE, message=FALSE, warning=FALSE}
library(knitr)
opts_chunk$set(echo = TRUE, collapse = TRUE, comment = "#>")
```


[![CRAN status](https://www.r-pkg.org/badges/version/kuenm2)](https://CRAN.R-project.org/package=kuenm2)
[![downloads](https://cranlogs.r-pkg.org/badges/grand-total/kuenm2)](https://cranlogs.r-pkg.org:443/badges/grand-total/kuenm2)
[![License](https://img.shields.io/badge/license-GPL%20(%3E=%203)-lightgrey.svg?style=flat)](http://www.gnu.org/licenses/gpl-3.0.html)
[![R-CMD-check](https://github.com/marlonecobos/kuenm2/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/marlonecobos/kuenm2/actions/workflows/R-CMD-check.yaml)







## Package description

**kuenm2** is an new version of **kuenm** [Cobos et al. 2019](https://peerj.com/articles/6281/), an R package designed to make the process of ecological niche modeling (ENM) easier, faster, and more reproducible, and at the same time more robust. The aim of this package is to facilitate crucial steps in the ENM process: data preparation, model calibration, selected model exploration, model projections, and analyses of uncertainty and variability. 

This new version of the package reduces the dependency on a strictly organized working directory (now required only if projections to multiple scenarios are needed). Instead, kuenm2 functions generate specific R objects that store all the necessary information for subsequent steps. kuenm2 fits maximum entropy (Maxnet) models or generalized linear models (GLMs). Maxnet models are created as described in [Phillips et al. (2017)](http://doi.wiley.com/10.1111/ecog.03049), and GLMs are constructed as in [Cobos and Peterson (2023)](https://doi.org/10.1371/journal.pone.0276951). The ENM workflow requires at minimum a `data.frame` containing occurrence record coordinates (longitude and latitude) and a `SpatRaster` object with predictor variables. Users could also use a `data.frame` containing a column indicating presence and background records (0/1), and other columns with predictor variable values.




## Installing the package

Note: Internet connection is required to install the package.

To install the latest release of kuenm2 use the following line of code:

```{r installation, eval=FALSE}
# Installing from CRAN 
install.packages("kuenm2")
```




The development version of kuenm2 can be installed using the code below. 

```{r installation1, eval=FALSE}
# Installing and loading packages
if(!require(remotes)) {
  install.packages("remotes")
}

# To install the package use
remotes::install_github("marlonecobos/kuenm2")

# To install the package and its vignettes use (if needed use: force = TRUE)  
remotes::install_github("marlonecobos/kuenm2", build_vignettes = TRUE)
```




*Having problems?* 

If you have any problems during installation of the development version from GitHub, restart R session, close other RStudio sessions you may have open, and try again. If during the installation you are asked to update packages, do so if you don't need a specific version of one or more of the packages to be installed. If any of the packages gives an error when updating, please install it alone using `install.packages()`, then try installing kuenm2 again.




To load the package use:

```{r loading, eval=FALSE}
# Load kuenm2
library(kuenm2)
```




## Workflow in kuenm2

The kuenm2 package facilitates the following steps in the ENM process: basic data cleaning, data preparation, model calibration, model exploration, model projections, projection comparisons, and exploration of variability and uncertainty. The figure below shows a schematic view of how the package works. A brief description of the steps that can be performed with the package is presented below. For a complete description and demonstration of the steps, see the package vignettes listed in the section [Checking the vignettes]. 

```{r fig1, echo=FALSE, fig.align='center', fig.height=4, fig.width=9, fig.cap="Figure 1. Overview of the kuenm2 workflow for ecological niche modeling."}
knitr::include_graphics("man/figures/kuenm2_map_gs.png")
```




### Pre-modeling steps

#### Basic data cleaning

kuenm2 automates essential pre-processing steps for ecological niche modeling. Data cleaning tools help sort columns, remove missing values and duplicates (including duplicates within raster cells), exclude coordinates at (0,0), filter based on coordinate decimal precision, and adjust occurrences that fall just outside valid raster boundaries. 


#### Data preparation

For data preparation, users can input raw occurrence records and raster layers or provide a pre-processed data frame. Two primary functions, `prepare_data()` and `prepare_user_data()`, guide users through the process of choosing modeling algorithms, defining parameter sets (e.g., feature classes, regularization multipliers, and predictor variables), and selecting data partitioning strategies. Additional tools allow users to visualize environmental conditions in the calibration data and assess similarities among training and testing partitions, an exclusive feature of kuenm2 among ENM tools.

#### Data exploration

The data that has been prepared can be explored to understand how it looks like in environmental and geographic spaces. This can give users an idea of what to expect from models, or whether some changes in the way data has been prepared are necessary. The main functions in the step of the workflow are `explore_calibration_hist()`, `plot_calibration_hist()`, `explore_partition_geo()`, `explore_partition_extrapolation()`, and `plot_explore_partition()`. 




### Model development

#### Model calibration 

Model calibration in kuenm2 is computationally intensive, involving training and testing of candidate models using various partitioning strategies such as k-fold cross-validation, subsampling, and bootstrapping. Custom partitions generated using external tools (e.g., block or checkerboard methods) can also be imported. Models are evaluated using multiple performance criteria that emphasize sensitivity due to the frequent lack of true absence data. These criteria include: bimodality in response curves, partial ROC for statistical significance, omission rates for predictive performance, and Akaike Information Criterion (AIC) for model complexity. Model calibration is executed using the `calibration()` function.

To support a deeper understanding of the calibration process, a step to explore extrapolation risks during the process of training and testing models can be performed in kuenm2. The function `partition_response_curves()` helps to produce visualizations of response curves from training data overlapped with environmental conditions at testing sites for selected models (another option exclusive to kuenm2).


#### Model explorations

Once best models are selected, they must be fitted using `fit_selected()` to analyze their characteristics and behavior. Fitted models can be explored to assess `variable_importance()` and examine response curves (`response_curve()` and `all_response_curves()`). This offers insights into predictor influence in models and ecological interpretation. 

If an independent set of records (not included for model calibration) is available, it can be used to re-evaluate the predictive performance of selected models using `independent_evaluation()`. Partial ROC and omission rates are calculated for these new records to measure model performance, but extrapolation risks also are assessed for these points using the MOP metric (exclusive to kuenm2). Results from this evaluation can help further filter the selected models or inform the decision to incorporate the independent records into the calibration dataset. 


#### Model projections

Fitted models can be projected to new environmental scenarios, including larger geographic areas or different temporal conditions (e.g., past or future climates). For single scenario projections, use `predict_selected()`; for multiple scenarios, use `project_selected()`. Before projecting to complex future scenarios (e.g., multiple time periods, emission pathways, or GCMs), users should first prepare and organize data using functions in *kuenm2* that facilitate the process (e.g., `organize_future_worldclim()`).




### Post-modeling analysis

#### Projection comparisons

When projecting to multiple scenarios, kuenm2 provides tools to quantify and characterize differences using `projection_changes()`. This function evaluates spatial changes and agreement levels among projections, aiding the interpretation of temporal or scenario-based shifts in suitability.


#### Variability and uncertainty

To assess the consistency and reliability of model outputs, users can explore projection variability (`projection_variability()`), which accounts for differences arising from model replicates, parameter sets, and climate models. With the MOP metric (`projection_mop()`) users can evaluate extrapolation risks by identifying novel environmental conditions in projection areas, offering a spatially explicit representation of model uncertainty.




## Checking the vignettes

Users can check kuenm2 vignettes for a full explanation of the package functionality. The vignettes can be checked online at the [kuenm2 site](https://marlonecobos.github.io/kuenm2/) under the menu *Articles*.
To build the vignettes when installing the package, if installing form GitHub, make sure to use the argument `build_vignettes = TRUE`.

Check each of the vignettes with the code below:

```{r vignettes, eval=FALSE}
# Guide to basic data cleaning before the ENM process
vignette("basic_data_cleaning")

# Guide to prepare data for the ENM process
vignette("prepare_data")

# Guide to train and evaluate candidate models, and select based on performance
vignette("model_calibration") 

# Guide to explore selected models, variable importance, response curves
vignette("model_exploration")

# Guide to predict models in geographic space (single scenarios)
vignette("model_predictions")

# Guide to project models in geographic space (multiple scenarios)
vignette("model_projections") 

# Guide to explore variability and uncertainty in projections (multiple scenarios)
vignette("variability_and_uncertainty")

# Guide to make projections to multiple scenarios with layers from CHELSA Climate
vignette("projections_chelsa")
```




## Note on AI usage

To maintain high standards of code quality and documentation, we have used AI LLM tools in our package. We used these tools for grammatical polishing and exploring technical implementation strategies for specialized functions. We manually checked and tested all code and documentation refined with these tools.




## Contributing

We welcome contributions to improve `kuenm2`! To maintain the integrity and performance of the package, we follow a few core principles:

- **Quality over Quantity:** We prioritize well-thought-out, stable improvements over frequent, minor changes. Please ensure your code is well-documented and follows the existing style of the package.
- **Minimal Dependencies:** One of the goals of `kuenm2` is to remain efficient. We prefer solutions that use base R or existing dependencies. Proposals that introduce new package dependencies will be strictly evaluated for their necessity.
- **AI-Assisted Code:** If you use AI agents (like Copilot, ChatGPT, or Claude) to generate code alternatives or improvements, please:
    - *Manually verify* the logic and accuracy of the output.
    - *Demonstrate the benefit* via a benchmark for speed or a clear explanation of how it fixes a bug/improves readability. Describe this in your Pull Request.
- **Testing:** New features should include examples, and tests should be performed to ensure they work as intended and do not break existing workflows.

If you have an idea for a major change, please open an Issue first to discuss it with the maintainers.

        

---

Owner metadata

• Name: Marlon E. Cobos
• Login: marlonecobos
• Email:
• Kind: user
• Description:
• Website: https://eeb.ku.edu/marlon-e-cobos
• Location: Lawrence, Kansas, USA
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/19596631?u=e6c23b6df2f033770f18c4d10926c717e29822ea&v=4
• Repositories: 31
• Last ynced at: 2023-08-19T12:11:50.310Z
• Profile URL: https://github.com/marlonecobos

---

GitHub Events

Total

• Pull request event: 96
• Watch event: 6
• Push event: 120

Last Year

• Pull request event: 36
• Watch event: 2
• Push event: 80

---

Committers metadata

Last synced: 3 days ago

Name	Email	Commits
wevertonbio	w****3@h****m	278
marlonecobos	m****3@g****m	197
marlonecobos	m****3@g****m	68
luisagi	a****e@g****m	40
Luis F. Arias-Giraldo	l****o@g****m	8
Luis Osorio	l****o@g****m	4

---

Issue and Pull Request metadata

Last synced: 6 days ago

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

---

---

---

Package metadata

• Total packages: 1
• Total downloads:
  • cran: 532 last-month
• Total dependent packages: 0
• Total dependent repositories: 0
• Total versions: 2
• Total maintainers: 1

---

Dependencies

Score: 10.46817616619227