rpaleoclim

R interface for PaleoClim paleoclimate data

https://github.com/joeroe/rpaleoclim

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 1 DOI reference(s) in README
  • Academic publication links
    Links to: nature.com, zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (20.9%) to scientific vocabulary

Keywords

paleoclimate r-package rstats
Last synced: 6 months ago · JSON representation

Repository

R interface for PaleoClim paleoclimate data

Basic Info
Statistics
  • Stars: 16
  • Watchers: 2
  • Forks: 1
  • Open Issues: 1
  • Releases: 3
Topics
paleoclimate r-package rstats
Created over 6 years ago · Last pushed over 2 years ago
Metadata Files
Readme Changelog Contributing License Codemeta

README.Rmd

---
output: github_document
---



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

# rpaleoclim: download paleoclimate data from PaleoClim in R


[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![CRAN status](https://www.r-pkg.org/badges/version/rpaleoclim)](https://CRAN.R-project.org/package=rpaleoclim)
[![R-CMD-check](https://github.com/joeroe/rpaleoclim/workflows/R-CMD-check/badge.svg)](https://github.com/joeroe/rpaleoclim/actions)
[![Codecov test coverage](https://codecov.io/gh/joeroe/rpaleoclim/branch/master/graph/badge.svg)](https://app.codecov.io/gh/joeroe/rpaleoclim?branch=master)
[![DOI](https://zenodo.org/badge/199434717.svg)](https://zenodo.org/badge/latestdoi/199434717)


[PaleoClim](http://www.paleoclim.org) is a set of free, high resolution paleoclimate surfaces covering the whole globe. 
It includes data on surface temperature, precipitation and the standard bioclimatic variables commonly used in  ecological modelling, derived from the HadCM3 general circulation model and  downscaled to a spatial resolution of up to 2.5 minutes. 

This package provides a simple interface for downloading PaleoClim data in R, with support for caching and filtering retrieved data by period, resolution, and geographic extent.

## Installation

You can install the latest release of rpaleoclim from [CRAN](https://cran.r-project.org/) with:

``` r
install.packages("rpaleoclim")
```

Or the development version from [GitHub](https://github.com/joeroe/rpaleoclim) using the [`remotes`](https://github.com/r-lib/remotes) package:

``` r
remotes::install_github("joeroe/rpaleoclim")
```

## Usage

The package includes two functions, `paleoclim()` and `load_paleoclim()`.
`paleoclim()` downloads data from PaleoClim with the desired period and resolution and reads it into R as a [SpatRaster](https://rspatial.org/spatial/4-rasterdata.html) object.

```{r rpaleoclim-demo, message=FALSE}
library("rpaleoclim")
library("terra") # For plotting

paleoclim("lh", "10m") |>
  plot()
```

By default, files from PaleoClim are cached in a local temporary directory to avoid repeated download of the same data.
`load_paleoclim()` reads local PaleoClim files (in `.zip` format) in the same way.

For further details see the [introduction to rpaleoclim](https://rpaleoclim.joeroe.io/articles/rpaleoclim.html) vignette (`vignette("rpaleoclim")`).

## Citation

Please follow the [instructions from the authors](http://www.paleoclim.org/how-to-cite/) when citing PaleoClim data. 
At time of writing, this includes a citation to the paper the describing the PaleoClim database:

* Brown, J.L., Hill, D.J., Dolan, A.M., Carnaval, A.C., Haywood, A.M., 2018. [PaleoClim, high spatial resolution paleoclimate surfaces for global land areas](https://www.nature.com/articles/sdata2018254). *Scientific Data* 5, 180254. doi:10.1038/sdata.2018.254

As well as the original papers for the individual original datasets used.

Use `citation("paleoclim")` for more details and the references in BibTeX format.

Owner

  • Name: Joe Roe
  • Login: joeroe
  • Kind: user
  • Location: Bern, Switzerland
  • Company: Institute for Archaeological Sciences, University of Bern

Computational archaeologist and R package developer.

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "rpaleoclim",
  "description": " PaleoClim <http://paleoclim.org> is a database of free, high resolution paleoclimate surfaces covering the whole globe. It includes the standard bioclimatic variables commonly used in ecological modelling, downscaled from the HadCM3 general circulation model for key time periods, at up to 2.5 minute spatial resolution. This package provides a simple interface for downloading PaleoClim data in R, with support for spatial queries and caching.",
  "name": "rpaleoclim: R Interface for the PaleoClim Paleoclimate Database",
  "codeRepository": "https://github.com/joeroe/rpaleoclim",
  "issueTracker": "https://github.com/joeroe/rpaleoclim/issues",
  "license": "https://spdx.org/licenses/MIT",
  "version": "0.9",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.1.2 (2021-11-01)",
  "author": [
    {
      "@type": "Person",
      "givenName": "Joe",
      "familyName": "Roe",
      "email": "joe@joeroe.io"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Joe",
      "familyName": "Roe",
      "email": "joe@joeroe.io"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "covr",
      "name": "covr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=covr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "mockery",
      "name": "mockery",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=mockery"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "version": ">= 3.0.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "utils",
      "name": "utils"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "rlang",
      "name": "rlang",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rlang"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "fs",
      "name": "fs",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=fs"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "rgdal",
      "name": "rgdal",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rgdal"
    },
    "5": {
      "@type": "SoftwareApplication",
      "identifier": "raster",
      "name": "raster",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=raster"
    },
    "6": {
      "@type": "SoftwareApplication",
      "identifier": "curl",
      "name": "curl",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=curl"
    },
    "SystemRequirements": null
  },
  "fileSize": "427.352KB",
  "citation": [
    {
      "@type": "ScholarlyArticle",
      "datePublished": "2018",
      "author": [
        {
          "@type": "Person",
          "givenName": "Brown",
          "familyName": "Jason L"
        },
        {
          "@type": "Person",
          "givenName": "Hill",
          "familyName": "Daniel J"
        },
        {
          "@type": "Person",
          "givenName": "Dolan",
          "familyName": "Aisling M"
        },
        {
          "@type": "Person",
          "givenName": "Carnaval",
          "familyName": "Ana C"
        },
        {
          "@type": "Person",
          "givenName": "Haywood",
          "familyName": "Alan M"
        }
      ],
      "name": "PaleoClim, high spatial resolution paleoclimate surfaces for global land areas",
      "identifier": "10.1038/sdata.2018.254",
      "url": "https://www.nature.com/articles/sdata2018254",
      "pagination": "180254",
      "@id": "https://doi.org/10.1038/sdata.2018.254",
      "sameAs": "https://doi.org/10.1038/sdata.2018.254",
      "isPartOf": {
        "@type": "PublicationIssue",
        "datePublished": "2018",
        "isPartOf": {
          "@type": [
            "PublicationVolume",
            "Periodical"
          ],
          "volumeNumber": "5",
          "name": "Scientific Data"
        }
      }
    },
    {
      "@type": "ScholarlyArticle",
      "datePublished": "2017",
      "author": [
        {
          "@type": "Person",
          "givenName": "Fordham",
          "familyName": "Damien A"
        },
        {
          "@type": "Person",
          "givenName": "Saltr",
          "familyName": "Frdrik"
        },
        {
          "@type": "Person",
          "givenName": "Haythorne",
          "familyName": "Sean"
        },
        {
          "@type": "Person",
          "givenName": "Wigley",
          "familyName": "Tom M L"
        },
        {
          "@type": "Person",
          "givenName": "Otto-Bliesner",
          "familyName": "Bette L"
        },
        {
          "@type": "Person",
          "givenName": "Chan",
          "familyName": "Ka Ching"
        },
        {
          "@type": "Person",
          "givenName": "Brook",
          "familyName": "Barry W"
        }
      ],
      "name": "PaleoView: a tool for generating continuous climate projections spanning the last 21 000 years at regional and global scales",
      "identifier": "10.1111/ecog.03031",
      "url": "https://onlinelibrary.wiley.com/doi/full/10.1111/ecog.03031",
      "pagination": "1348-1358",
      "@id": "https://doi.org/10.1111/ecog.03031",
      "sameAs": "https://doi.org/10.1111/ecog.03031",
      "isPartOf": {
        "@type": "PublicationIssue",
        "datePublished": "2017",
        "isPartOf": {
          "@type": [
            "PublicationVolume",
            "Periodical"
          ],
          "volumeNumber": "40",
          "name": "Ecography"
        }
      }
    },
    {
      "@type": "ScholarlyArticle",
      "datePublished": "2006",
      "author": [
        {
          "@type": "Person",
          "givenName": "Otto-Bliesner",
          "familyName": "Bette L."
        },
        {
          "@type": "Person",
          "givenName": "Marshall",
          "familyName": "Shawn J."
        },
        {
          "@type": "Person",
          "givenName": "Overpeck",
          "familyName": "Jonathan T."
        },
        {
          "@type": "Person",
          "givenName": "Miller",
          "familyName": "Gifford H."
        },
        {
          "@type": "Person",
          "givenName": "Hu",
          "familyName": "Aixue"
        },
        {
          "@type": "Person",
          "givenName": [
            "CAPE",
            "Last",
            "Interglacial",
            "Project"
          ],
          "familyName": "members"
        }
      ],
      "name": "Simulating Arctic Climate Warmth and Icefield Retreat in the Last Interglaciation",
      "identifier": "10.1126/science.1120808",
      "url": "https://www.science.org/doi/10.1126/science.1120808",
      "pagination": "1751-1753",
      "@id": "https://doi.org/10.1126/science.1120808",
      "sameAs": "https://doi.org/10.1126/science.1120808",
      "isPartOf": {
        "@type": "PublicationIssue",
        "datePublished": "2006",
        "isPartOf": {
          "@type": [
            "PublicationVolume",
            "Periodical"
          ],
          "volumeNumber": "311",
          "name": "Science"
        }
      }
    },
    {
      "@type": "ScholarlyArticle",
      "datePublished": "2015",
      "author": [
        {
          "@type": "Person",
          "givenName": "Hill",
          "familyName": "Daniel J"
        }
      ],
      "name": "The non-analogue nature of Pliocene temperature gradients ",
      "identifier": "10.1016/j.epsl.2015.05.044",
      "url": "https://www.sciencedirect.com/science/article/pii/S0012821X15003428",
      "pagination": "232-241",
      "@id": "https://doi.org/10.1016/j.epsl.2015.05.044",
      "sameAs": "https://doi.org/10.1016/j.epsl.2015.05.044",
      "isPartOf": {
        "@type": "PublicationIssue",
        "datePublished": "2015",
        "isPartOf": {
          "@type": [
            "PublicationVolume",
            "Periodical"
          ],
          "volumeNumber": "425",
          "name": "Earth and Planetary Science Letters"
        }
      }
    },
    {
      "@type": "ScholarlyArticle",
      "datePublished": "2015",
      "author": [
        {
          "@type": "Person",
          "givenName": "Dolan",
          "familyName": "Aisling M"
        },
        {
          "@type": "Person",
          "givenName": "Haywood",
          "familyName": "Alan M"
        },
        {
          "@type": "Person",
          "givenName": "Hunter",
          "familyName": "Stephen J"
        },
        {
          "@type": "Person",
          "givenName": "Tindall",
          "familyName": "Julia C"
        },
        {
          "@type": "Person",
          "givenName": "Dowsett",
          "familyName": "Harry J"
        },
        {
          "@type": "Person",
          "givenName": "Hill",
          "familyName": "Daniel J"
        },
        {
          "@type": "Person",
          "givenName": "Pickering",
          "familyName": "Steven J"
        }
      ],
      "name": "Modelling the enigmatic Late Pliocene Glacial Event  Marine Isotope Stage M2",
      "identifier": "10.1016/j.gloplacha.2015.02.001",
      "url": "https://www.sciencedirect.com/science/article/pii/S0921818115000399",
      "pagination": "47-60",
      "@id": "https://doi.org/10.1016/j.gloplacha.2015.02.001",
      "sameAs": "https://doi.org/10.1016/j.gloplacha.2015.02.001",
      "isPartOf": {
        "@type": "PublicationIssue",
        "datePublished": "2015",
        "isPartOf": {
          "@type": [
            "PublicationVolume",
            "Periodical"
          ],
          "volumeNumber": "128",
          "name": "Global and Planetary Change"
        }
      }
    },
    {
      "@type": "ScholarlyArticle",
      "datePublished": "2017",
      "author": [
        {
          "@type": "Person",
          "givenName": "Karger",
          "familyName": "Dirk Nikolaus"
        },
        {
          "@type": "Person",
          "givenName": "Conrad",
          "familyName": "Olaf"
        },
        {
          "@type": "Person",
          "givenName": "Bhner",
          "familyName": "Jrgen"
        },
        {
          "@type": "Person",
          "givenName": "Kawohl",
          "familyName": "Tobias"
        },
        {
          "@type": "Person",
          "givenName": "Kreft",
          "familyName": "Holger"
        },
        {
          "@type": "Person",
          "givenName": "Soria-Auza",
          "familyName": "Rodrigo Wilber"
        },
        {
          "@type": "Person",
          "givenName": "Zimmermann",
          "familyName": "Niklaus E"
        },
        {
          "@type": "Person",
          "givenName": "Linder",
          "familyName": "H Peter"
        },
        {
          "@type": "Person",
          "givenName": "kessler",
          "familyName": "Michael"
        }
      ],
      "name": "Climatologies at high resolution for the earths land surface areas",
      "identifier": "10.1038/sdata.2017.122",
      "url": "https://www.nature.com/articles/sdata2017122",
      "pagination": "170122",
      "@id": "https://doi.org/10.1038/sdata.2017.122",
      "sameAs": "https://doi.org/10.1038/sdata.2017.122",
      "isPartOf": {
        "@type": "PublicationIssue",
        "datePublished": "2017",
        "isPartOf": {
          "@type": [
            "PublicationVolume",
            "Periodical"
          ],
          "volumeNumber": "4",
          "name": "Scientific Data"
        }
      }
    }
  ],
  "readme": "https://github.com/joeroe/rpaleoclim/blob/master/README.md",
  "contIntegration": [
    "https://github.com/joeroe/rpaleoclim/actions",
    "https://app.codecov.io/gh/joeroe/rpaleoclim?branch=master"
  ],
  "developmentStatus": "https://www.repostatus.org/#wip",
  "keywords": [
    "rstats",
    "r-package",
    "paleoclimate"
  ]
}

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 18
  • Total pull requests: 1
  • Average time to close issues: 6 months
  • Average time to close pull requests: 10 minutes
  • Total issue authors: 4
  • Total pull request authors: 1
  • Average comments per issue: 1.11
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 1
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • joeroe (15)
  • rsbivand (1)
  • github-actions[bot] (1)
  • jhavill (1)
Pull Request Authors
  • joeroe (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 256 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 2
  • Total maintainers: 1
cran.r-project.org: rpaleoclim

Download Paleoclimate Data from 'PaleoClim'

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 256 Last month
Rankings
Stargazers count: 19.7%
Forks count: 21.8%
Dependent packages count: 29.5%
Dependent repos count: 35.2%
Average: 39.2%
Downloads: 89.7%
Maintainers (1)
Last synced: 7 months ago

Dependencies

DESCRIPTION cran
  • curl * imports
  • fs * imports
  • rlang * imports
  • terra * imports
  • utils * imports
  • covr * suggests
  • knitr * suggests
  • mockery * suggests
  • raster >= 3.0 suggests
  • rgdal * suggests
  • rmarkdown * suggests
  • testthat >= 3.0.0 suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.4.1 composite
  • 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
.github/workflows/test-coverage.yaml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite