climr

An R package for downscaling monthly climate data for North America

https://github.com/bcgov/climr

Science Score: 49.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 11 DOI reference(s) in README
  • Academic publication links
    Links to: wiley.com
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.5%) to scientific vocabulary

Keywords

climate-data flnr r rstats-package

Keywords from Contributors

shinyapps
Last synced: 6 months ago · JSON representation

Repository

An R package for downscaling monthly climate data for North America

Basic Info
Statistics
  • Stars: 17
  • Watchers: 5
  • Forks: 6
  • Open Issues: 51
  • Releases: 6
Topics
climate-data flnr r rstats-package
Created over 4 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog Contributing Code of conduct

README.md

climr

Lifecycle:Maturing Codecov test coverage - main

climr: An R package of downscaled climate data for North America

climr is an R package that builds on the downscaling concepts operationalized in the ClimateNA tool (Wang et al. 2016). It provides downscaling of observational and simulated climate data using change-factor (a.k.a. climate imprint) downscaling, a simple method that adds low-spatial-resolution climate anomalies to a high-spatial-resolution reference climatological map, with additional elevation adjustment for "scale-free" downscaling. climr is designed to be fast and to minimize local data storage requirements. To do so, it uses a remote PostGIS database, and optionally caches data locally.

Subscribe

We are actively developing climr and releasing minor versions every month or two. If you would like to receive email updates when new versions of climr are released, subscribe to the climr GitHub repo using the following steps:

  1. Navigate to https://github.com/bcgov/climr.
  2. Click the "Watch" button at the top right of the repository page.
  3. Choose "Custom".
  4. Select "Releases".

Features

climr provides the following data:

  • Three historical observational time series: (1) the 1901-2022 combined Climatic Research Unit TS dataset (for temperature) and Global Precipitation Climatology Centre dataset (for precipitation); (2) the 1901-2023 ClimateNA time series (Wang et al., 2024); and (3) the 1981-2024 Multi-Source Weather (MSWX; for temperature) and Multi-Source Weighted-Ensemble Precipitation (MSWEP; for precipitation), extended back to 1901 using the CRU/GPCC dataset.

  • Multiple historical (1851-2014) and future (2015-2100) climate model simulations for each of 13 CMIP6 global climate models, in monthly time series and 20-year normals.

  • User selection of single or multiple climate variables, with derived variables following the ClimateNA methodology of Wang et al. (2016).

Data Sources

The default reference climate maps for North America are a custom 2.5km-resolution mosaic of BC PRISM, US PRISM, deep learning prediction (Yukon, Northwest Territories, and Alberta), and Daymet (rest of North America). The climr mosaic is described in vignette("climr_methods_mosaic"). The alternative 4km-resolution ClimateNA mosaics of PRISM (BC, US, W. Canada) and WorldClim (rest of North America) are accessed from AdaptWest.

The default historical observational time series are obtained from Climatic Research Unit, Global Precipitation Climatology Centre, and ClimateNA (Wang et al. 2016), .

CMIP6 global climate model simulations were downloaded from the Earth System Grid Federation. The majority of these downloads were conducted by Tongli Wang, Associate Professor at the UBC Department of Forest and Conservation Sciences. The 13 global climate models selected for climr, and best practices for ensemble analysis, are described in Mahony et al. (2022) and summarized in vignette("climr_methods_ensembleSelection").

Installation

climr is only available on GitHub. To install please use:

r remotes::install_github("bcgov/climr")

If you want to install the development version:

r remotes::install_github("bcgov/climr@devl") If you get an error on installation, try the following: r options(download.file.method = "libcurl") and then rerun install_github(). On some computers, the default R download method doesn't play nicely with github.

Usage

See vignette("climr_workflow_beg") to get started with simple climr workflows;

Methods

For an overview of downscaling methods used in climr see vignette("methods_downscaling")

Known issues

  • Downloads of time series take a long time. We recommend users dedicate some time prior to analysis to cache their time series of interest for their areas of interest in a batch. Once the time series are cached, they don't need to be downloaded again.
  • We are still working on the documentation, examples, and vignettes. Please let us know if something isn't clear, preferably as a GitHub issue.

License

Copyright 2024 Province of British Columbia

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

climr logo uses icon designed by Freepik, Flaticon.com, available here.

Acknowledgements

We acknowledge the World Climate Research Programme, which, through its Working Group on Coupled Modelling, coordinated and promoted CMIP6. We thank the climate modeling groups for producing and making available their model output, the Earth System Grid Federation (ESGF) for archiving the data and providing access, and the multiple funding agencies who support CMIP6 and ESGF.

References

Mahony, C.R., T. Wang, A. Hamann, and A.J. Cannon. 2022. A global climate model ensemble for downscaled monthly climate normals over North America. International Journal of Climatology. 42:5871-5891. doi.org/10.1002/joc.7566

Wang, Tongli, Andreas Hamann, Dave Spittlehouse, and Carlos Carroll. 2016. Locally Downscaled and Spatially Customizable Climate Data for Historical and Future Periods for North America. Edited by Ins lvarez. PLOS ONE 11 (6): e0156720.

Wang, Tongli, Andreas Hamann, and Zihaohan Sang. 2024. Monthly High-Resolution Historical Climate Data for North America Since 1901. International Journal of Climatology. early view: https://doi.org/10.1002/joc.8726.

Owner

  • Name: bcgov
  • Login: bcgov
  • Kind: organization
  • Email: Developer.Experience@gov.bc.ca
  • Location: Canada

This is the home for code that is open

GitHub Events

Total
  • Create event: 4
  • Release event: 2
  • Issues event: 140
  • Watch event: 1
  • Member event: 2
  • Issue comment event: 124
  • Push event: 133
  • Pull request review event: 1
  • Pull request event: 16
  • Fork event: 1
Last Year
  • Create event: 4
  • Release event: 2
  • Issues event: 140
  • Watch event: 1
  • Member event: 2
  • Issue comment event: 124
  • Push event: 133
  • Pull request review event: 1
  • Pull request event: 16
  • Fork event: 1

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 412
  • Total Committers: 10
  • Avg Commits per committer: 41.2
  • Development Distribution Score (DDS): 0.381
Past Year
  • Commits: 320
  • Committers: 5
  • Avg Commits per committer: 64.0
  • Development Distribution Score (DDS): 0.203
Top Committers
Name Email Commits
CeresBarros c****s@g****a 255
Bruno Tremblay m****z@n****m 62
Kiri k****t@g****m 28
Daust K****t@g****a 26
cmahony c****y@g****a 21
FrankBornais f****t@l****m 8
Nicolas Gauthier n****r@l****m 7
repo-mountie[bot] 4****] 3
Bruno Tremblay b****y@l****m 1
Kiri Daust 3****t 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 157
  • Total pull requests: 38
  • Average time to close issues: 3 months
  • Average time to close pull requests: 3 days
  • Total issue authors: 14
  • Total pull request authors: 5
  • Average comments per issue: 1.85
  • Average comments per pull request: 1.5
  • Merged pull requests: 31
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 71
  • Pull requests: 12
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 9 days
  • Issue authors: 11
  • Pull request authors: 4
  • Average comments per issue: 1.42
  • Average comments per pull request: 0.0
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • cmahony (116)
  • CeresBarros (51)
  • meztez (21)
  • kdaust (12)
  • whmacken (7)
  • tiriongrice (5)
  • achubaty (3)
  • ElizabethKleynhans (2)
  • cour10eygrace (2)
  • bcaradima (1)
  • steffilazerte (1)
  • see24 (1)
  • DonMorgan (1)
  • dorjismo (1)
Pull Request Authors
  • CeresBarros (38)
  • cmahony (16)
  • kdaust (9)
  • meztez (7)
  • achubaty (7)
  • FrankBornais (2)
  • eliotmcintire (1)
Top Labels
Issue Labels
bug (63) enhancement (61) v1.0.0 (32) documentation (23) to do (20) v0.0.5 (18) v0.2.0 (16) climr-app (9) validation (9) v0.0.4 (9) non-urgent (8) question (8) urgent (7) v2.0.0 (7) Urgent (7) v0.0.3 (6) future work (4) user (3) v0.3.0 (3) priority (3) version1 (3) help wanted (1) version2 (1) in progress (1)
Pull Request Labels
enhancement (10) documentation (8) bug (6) to do (6) v0.0.5 (4) v0.2.0 (2) v0.0.3 (2) v1.0.0 (2) priority (1) Urgent (1) question (1)

Dependencies

DESCRIPTION cran
  • R >= 4.0 depends
  • data.table * imports
  • gh * imports
  • methods * imports
  • parallel * imports
  • terra * imports
  • rmarkdown * suggests
  • testthat >= 3.0.0 suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v3 composite
  • actions/upload-artifact main composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
.github/workflows/test-coverage.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite