ccviR

A rapid assessment tool designed to allow a relative grouping of unrelated taxa by vulnerability to climate change and to highlight which factors contribute to the climate change vulnerability of individual species or groups of taxa.
https://github.com/landscitech/ccvir

Category: Climate Change
Sub Category: Climate Data Processing and Analysis

Last synced: about 21 hours ago
JSON representation

Repository metadata

Implement NatureServe climate change vulnerability index in R

README.Rmd

          ---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# ccviR 



[![R-CMD-check](https://github.com/LandSciTech/ccviR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/LandSciTech/ccviR/actions/workflows/R-CMD-check.yaml)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![DOI](https://joss.theoj.org/papers/10.21105/joss.07150/status.svg)](https://doi.org/10.21105/joss.07150)


The ccviR package implements the [NatureServe Climate Change Vulnerability Index (CCVI) version 3.02](https://www.natureserve.org/conservation-tools/climate-change-vulnerability-index) in an R package and Shiny App. The package allows all of the geospatial aspects of calculating the CCVI to be done in R, removing the need for separate GIS calculations. The app provides an interactive application designed to offer a user-friendly and simple interface for calculating the NatureServe CCVI. 

The NatureServe CCVI is a rapid assessment tool designed to allow a relative grouping of unrelated taxa by vulnerability to climate change and to highlight which factors contribute to the climate change vulnerability of individual species or groups of taxa. This information can be used to inform conservation decision making and to help identify actions to increase species resilience to climate change. See [Young et. al (2012)](https://www.degruyter.com/document/doi/10.7208/9780226074641-007/html), [Young et. al. (2015)](https://doi.org/10.1002/wsb.478) and the [NatureServe CCVI Guidelines](https://www.natureserve.org/sites/default/files/guidelines_natureserveclimatechangevulnerabilityindex_r3.02_1_jun_2016.pdf) for more detailed descriptions of the index and how it was created.

## Installation

You can install the development version of ccviR from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("LandSciTech/ccviR")
```

## Launching the app

The code below will open the app in your default browser with an example data set available. 

```r 
library(ccviR)
run_ccvi_app("demo")
```
While the following will open the app with the current working directory as the default data location.

```r 
run_ccvi_app()
```

## Comparison to the NatureServe CCVI tool
 
ccviR uses the same vulnerability factors and scoring algorithm as the original NatureServe Excel spreadsheet. The index values, scores and Monte Carlo uncertainty analysis produced are the same.

### New Features
- Spatial analyses are included in the package so only minimal GIS skills are needed 
- Uses climate data from the whole species range rather than the range in the assessment area to score thermal and hydrological niche factors
- Simultaneously calculates the index for multiple scenarios such as, emissions scenarios, time horizons or GCMs
- A function and Shiny app to classify new climate data sets into exposure categories 
- Plots that explain the drivers of the index value
- Allows the full assessment to be carried out in a reproducible environment
- Simplifies synthetic analyses across many species, groups or regions
- The Shiny app provides a Graphical User Interface to calculate the NatureServe CCVI
- The Shiny app allows users to calculate the index without knowing R
- Makes the NatureServe CCVI accessible to a wider audience


## Vignettes/tutorials available

See `vignette("app_vignette", package = "ccviR")` for an introduction to how to use the app with a demo data set, `vignette("app_details_vignette", package = "ccviR")` for a more detailed look at how to use the app in practice, `vignette("data_prep_vignette", package = "ccviR")` for how to use an app to prepare custom climate data sets, and `vignette("package_vignette", package = "ccviR")` for a tutorial on how to use the package to calculate the index directly in R.


## Citation 

  Endicott, S., Naujokaitis-Lewis, I., 2024. ccviR: an R package and Shiny app
  to implement the NatureServe Climate Change Vulnerability Index. Journal of
  Open Source Software 9, 7150. https://doi.org/10.21105/joss.07150

        

Citation (CITATION.cff)

cff-version: "1.2.0"
authors:
- family-names: Endicott
  given-names: Sarah
  orcid: "https://orcid.org/0000-0001-9644-5343"
- family-names: Naujokaitis-Lewis
  given-names: Ilona
  orcid: "https://orcid.org/0000-0001-9504-4484"
doi: 10.5281/zenodo.14170051
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Endicott
    given-names: Sarah
    orcid: "https://orcid.org/0000-0001-9644-5343"
  - family-names: Naujokaitis-Lewis
    given-names: Ilona
    orcid: "https://orcid.org/0000-0001-9504-4484"
  date-published: 2024-11-15
  doi: 10.21105/joss.07150
  issn: 2475-9066
  issue: 103
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 7150
  title: "ccviR: an R package and Shiny app to implement the NatureServe
    Climate Change Vulnerability Index"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.07150"
  volume: 9
title: "ccviR: an R package and Shiny app to implement the NatureServe
  Climate Change Vulnerability Index"

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 10 days ago

Total Commits: 546
Total Committers: 6
Avg Commits per committer: 91.0
Development Distribution Score (DDS): 0.152

Commits in past year: 78
Committers in past year: 4
Avg Commits per committer in past year: 19.5
Development Distribution Score (DDS) in past year: 0.218

Name Email Commits
see24 s****4@g****m 463
Sarah Endicott s****t@e****a 61
Adriana Caswell a****l@e****a 16
ilonaECCC 6****C 4
sarahouimette s****6@u****a 1
sarahgeargeoura 1****a 1

Committer domains:


Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 189
Total pull requests: 57
Average time to close issues: 5 months
Average time to close pull requests: 1 day
Total issue authors: 8
Total pull request authors: 5
Average comments per issue: 1.73
Average comments per pull request: 0.18
Merged pull request: 53
Bot issues: 0
Bot pull requests: 0

Past year issues: 29
Past year pull requests: 14
Past year average time to close issues: 2 months
Past year average time to close pull requests: 4 days
Past year issue authors: 4
Past year pull request authors: 3
Past year average comments per issue: 2.52
Past year average comments per pull request: 0.07
Past year merged pull request: 12
Past year bot issues: 0
Past year bot pull requests: 0

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

Top Issue Authors

  • see24 (129)
  • adricaswell (32)
  • sarahgeargeoura (12)
  • steffilazerte (7)
  • sebdalgarno (3)
  • plestiodon (3)
  • out2lunch22 (2)
  • mengqi-z (1)

Top Pull Request Authors

  • see24 (45)
  • adricaswell (6)
  • ilonaECCC (4)
  • steffilazerte (1)
  • sarahgeargeoura (1)

Top Issue Labels

  • enhancement (73)
  • bug (47)
  • Priority: High (34)
  • documentation (19)
  • Priority: Low (15)
  • question (5)
  • wontfix (2)
  • test needed (2)
  • Priority: Med (2)
  • help wanted (2)
  • good first issue (1)

Top Pull Request Labels


Dependencies

DESCRIPTION cran
  • R >= 2.10 depends
  • R.utils * imports
  • dplyr * imports
  • exactextractr * imports
  • fs * imports
  • ggplot2 * imports
  • pkgload * imports
  • plotly * imports
  • purrr * imports
  • raster * imports
  • rgdal * imports
  • scales * imports
  • sf * imports
  • shiny * imports
  • shinyFiles * imports
  • shinycssloaders * imports
  • shinyjs * imports
  • shinyvalidate * imports
  • stats * imports
  • stringr * imports
  • tidyr * imports
  • tmap * imports
  • units * imports
  • utils * imports
  • furrr * suggests
  • future * suggests
  • knitr * suggests
  • readxl * suggests
  • rmarkdown * suggests
  • shinytest * suggests
  • testthat >= 2.1.0 suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/check-r-package v1 composite
  • r-lib/actions/setup-r v1 composite
  • r-lib/actions/setup-r-dependencies v1 composite
.github/workflows/pkgdown.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
  • r-lib/actions/setup-r-dependencies v1 composite

Score: 5.529429087511423