rerddap

R client for working with ERDDAP servers

Science Score: 36.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
○
Academic publication links
✓
Committers with academic emails
1 of 11 committers (9.1%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (16.2%) to scientific vocabulary

Keywords

api-client erddap noaa-data r r-package rstats

Keywords from Contributors

air-pollution turfjs turf geojson critical-care electronic-health-record healthcare intensive-care bicycle-hire bicycle-hire-systems

Last synced: 4 months ago · JSON representation

Repository

R client for working with ERDDAP servers

Basic Info

Host: GitHub
Owner: ropensci
License: other
Language: R
Default Branch: master
Homepage: https://docs.ropensci.org/rerddap
Size: 96.2 MB

Statistics

Stars: 41
Watchers: 4
Forks: 15
Open Issues: 2
Releases: 23

Topics

api-client erddap noaa-data r r-package rstats

Created about 11 years ago · Last pushed 7 months ago

Metadata Files

Readme Changelog Contributing License Codemeta

README.Rmd

rerddap
=====

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

[![cran checks](https://badges.cranchecks.info/worst/rerddap.svg)](https://cran.r-project.org/web/checks/check_results_rerddap.html)
  [![R-CMD-check](https://github.com/ropensci/rerddap/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ropensci/rerddap/actions/workflows/R-CMD-check.yaml)
[![codecov.io](https://codecov.io/github/ropensci/rerddap/coverage.svg?branch=master)](https://codecov.io/github/ropensci/rerddap?branch=master)
[![rstudio mirror downloads](https://cranlogs.r-pkg.org/badges/rerddap)](https://github.com/r-hub/cranlogs.app)
[![cran version](https://www.r-pkg.org/badges/version/rerddap)](https://cran.r-project.org/package=rerddap)


`rerddap` is a general purpose R client for working with ERDDAP servers.

Package Docs: 

## Installation

From CRAN

```{r eval=FALSE}
install.packages("rerddap")
```

Or development version from GitHub

```{r eval=FALSE}
remotes::install_github("ropensci/rerddap")
```

```{r}
library("rerddap")
```

Some users may experience an installation error, stating to install 1 or more 
packages, e.g., you may need `DBI`, in which case do, for example, 
`install.packages("DBI")` before installing `rerddap`.

## Background

ERDDAP is a server built on top of OPenDAP, which serves some NOAA data. You can get gridded data (griddap ()), which lets you query from gridded datasets, or table data (tabledap ()) which lets you query from tabular datasets. In terms of how we interface with them, there are similarities, but some differences too. We try to make a similar interface to both data types in `rerddap`.

## NetCDF

`rerddap` supports NetCDF format, and is the default when using the `griddap()` function. NetCDF is a binary file format, and will have a much smaller footprint on your disk than csv. The binary file format means it's harder to inspect, but the `ncdf4` package makes it easy to pull data out and write data back into a NetCDF file. Note the the file extension for NetCDF files is `.nc`. Whether you choose NetCDF or csv for small files won't make much of a difference, but will with large files.

## Caching

Data files downloaded are cached in a single directory on your machine determined by the `hoardr` package. When you use `griddap()` or `tabledap()` functions, we construct a MD5 hash from the base URL, and any query parameters - this way each query is separately cached. Once we have the hash, we look in the cache directory for a matching hash. If there's a match we use that file on disk - if no match, we make a http request for the data to the ERDDAP server you specify.

## ERDDAP servers

You can get a data.frame of ERDDAP servers using the function `servers()`. Most I think serve some kind of NOAA data, but there are a few that aren't NOAA data.  If you know of more ERDDAP servers, send a pull request, or let us know.

## Meta

* Please [report any issues or bugs](https://github.com/ropensci/rerddap/issues).
* License: MIT
* Get citation information for `rerddap` in R doing `citation(package = 'rerddap')`
* Please note that this package is released with a [Contributor Code of Conduct](https://ropensci.org/code-of-conduct/). By contributing to this project, you agree to abide by its terms.

Owner

Name: rOpenSci
Login: ropensci
Kind: organization
Email: info@ropensci.org
Location: Berkeley, CA

Website: https://ropensci.org/
Twitter: rOpenSci
Repositories: 307
Profile: https://github.com/ropensci

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "rerddap",
  "description": "General purpose R client for 'ERDDAP™' servers. Includes functions to search for 'datasets', get summary information on 'datasets', and fetch 'datasets', in either 'csv' or 'netCDF' format. 'ERDDAP™' information: <https://upwell.pfeg.noaa.gov/erddap/information.html>.",
  "name": "rerddap: General Purpose Client for 'ERDDAP™' Servers",
  "relatedLink": "https://docs.ropensci.org/rerddap/",
  "codeRepository": "https://github.com/ropensci/rerddap",
  "issueTracker": "https://github.com/ropensci/rerddap/issues",
  "license": "https://spdx.org/licenses/MIT",
  "version": "1.2.0",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.4.2 (2024-10-31)",
  "provider": {
    "@id": "https://cran.r-project.org",
    "@type": "Organization",
    "name": "Comprehensive R Archive Network (CRAN)",
    "url": "https://cran.r-project.org"
  },
  "author": [
    {
      "@type": "Person",
      "givenName": "Scott",
      "familyName": "Chamberlain"
    }
  ],
  "contributor": [
    {
      "@type": "Person",
      "givenName": "Ben",
      "familyName": "Tupper"
    },
    {
      "@type": "Person",
      "givenName": "Salvador Jesús Fernández",
      "familyName": "Bejarano"
    },
    {
      "@type": "Person",
      "givenName": "Roy",
      "familyName": "Mendelssohn",
      "email": "roy.mendelssohn@noaa.gov"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Roy",
      "familyName": "Mendelssohn",
      "email": "roy.mendelssohn@noaa.gov"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "knitr",
      "name": "knitr",
      "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=knitr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rmarkdown",
      "name": "rmarkdown",
      "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=rmarkdown"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "R",
      "name": "R",
      "version": ">= 4.00"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "crul",
      "name": "crul",
      "version": ">= 0.7.4",
      "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=crul"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "dplyr",
      "name": "dplyr",
      "version": ">= 0.5.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=dplyr"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "data.table",
      "name": "data.table",
      "version": ">= 1.12.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=data.table"
    },
    "5": {
      "@type": "SoftwareApplication",
      "identifier": "digest",
      "name": "digest",
      "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=digest"
    },
    "6": {
      "@type": "SoftwareApplication",
      "identifier": "hoardr",
      "name": "hoardr",
      "version": ">= 0.5.2",
      "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=hoardr"
    },
    "7": {
      "@type": "SoftwareApplication",
      "identifier": "jsonlite",
      "name": "jsonlite",
      "version": ">= 1.6",
      "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=jsonlite"
    },
    "8": {
      "@type": "SoftwareApplication",
      "identifier": "lubridate",
      "name": "lubridate",
      "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=lubridate"
    },
    "9": {
      "@type": "SoftwareApplication",
      "identifier": "methods",
      "name": "methods"
    },
    "10": {
      "@type": "SoftwareApplication",
      "identifier": "nanoparquet",
      "name": "nanoparquet",
      "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=nanoparquet"
    },
    "11": {
      "@type": "SoftwareApplication",
      "identifier": "ncdf4",
      "name": "ncdf4",
      "version": ">= 1.16",
      "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=ncdf4"
    },
    "12": {
      "@type": "SoftwareApplication",
      "identifier": "tibble",
      "name": "tibble",
      "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=tibble"
    },
    "13": {
      "@type": "SoftwareApplication",
      "identifier": "utils",
      "name": "utils"
    },
    "14": {
      "@type": "SoftwareApplication",
      "identifier": "xml2",
      "name": "xml2",
      "version": ">= 1.2.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=xml2"
    },
    "SystemRequirements": null
  },
  "applicationCategory": "Climate",
  "isPartOf": "https://ropensci.org",
  "keywords": [
    "earth",
    "science",
    "climate",
    "precipitation",
    "temperature",
    "storm",
    "buoy",
    "NOAA",
    "rstats",
    "erddap",
    "noaa-data",
    "api-client",
    "r",
    "r-package"
  ],
  "fileSize": "3018.425KB",
  "releaseNotes": "https://github.com/ropensci/rerddap/blob/master/NEWS.md",
  "readme": "https://github.com/ropensci/rerddap/blob/master/README.md",
  "contIntegration": [
    "https://github.com/ropensci/rerddap/actions/workflows/R-CMD-check.yaml",
    "https://codecov.io/github/ropensci/rerddap?branch=master"
  ]
}

GitHub Events

Total

Create event: 2
Release event: 1
Issues event: 8
Watch event: 1
Issue comment event: 15
Push event: 11
Pull request event: 3

Last Year

Create event: 2
Release event: 1
Issues event: 8
Watch event: 1
Issue comment event: 15
Push event: 11
Pull request event: 3

Committers

Last synced: 7 months ago

All Time

Total Commits: 348
Total Committers: 11
Avg Commits per committer: 31.636
Development Distribution Score (DDS): 0.126

Past Year

Commits: 11
Committers: 2
Avg Commits per committer: 5.5
Development Distribution Score (DDS): 0.273

Top Committers

Name	Email	Commits
Scott Chamberlain	m**s@g**m	304
Roy Mendelssohn	r**n@n**v	28
Ben Tupper	b**r@b**g	4
Roy Mendelssohn		3
Jeroen Ooms	j**s@g**m	2
Doug Latornell	d**l@d**a	2
Maëlle Salmon	m**n@y**e	1
Kyle Wilcox	w**e@g**m	1
Darío Hereñú	m**a@g**m	1
Brett Johnson	b**n@h**g	1
rOpenSci Bot	m**t@g**m	1

Committer Domains (Top 20 + Academic)

hakai.org: 1 douglatornell.ca: 1 bigelow.org: 1 noaa.gov: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 102
Total pull requests: 11
Average time to close issues: 9 months
Average time to close pull requests: 13 days
Total issue authors: 29
Total pull request authors: 10
Average comments per issue: 3.0
Average comments per pull request: 6.82
Merged pull requests: 8
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 5
Pull requests: 3
Average time to close issues: 1 day
Average time to close pull requests: 20 days
Issue authors: 4
Pull request authors: 2
Average comments per issue: 2.0
Average comments per pull request: 2.0
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

sckott (60)
rmendels (9)
afredston (3)
LuisLauM (3)
jordi-1 (2)
schckngs (2)
jeroen (1)
FishyguyNeel (1)
mwengren (1)
chrisdane (1)
annbel (1)
John-Brandon (1)
adamml (1)
Bluri19 (1)
reblake (1)

Pull Request Authors

boshek (2)
salvafern (1)
Br-Johnson (1)
kant (1)
sckott (1)
kwilcox (1)
btupper (1)
cpsievert (1)
douglatornell (1)
rmendels (1)

Top Labels

Issue Labels

bug (15) from-email (2) visualization (2) plotdap-pkg (2) docs (1)

Pull Request Labels

Packages

Total packages: 2
Total downloads:
- cran 1,004 last-month
Total docker downloads: 111,120

Total dependent packages: 4
(may contain duplicates)
Total dependent repositories: 14
(may contain duplicates)
Total versions: 45
Total maintainers: 1

proxy.golang.org: github.com/ropensci/rerddap

Documentation: https://pkg.go.dev/github.com/ropensci/rerddap#section-documentation
License: other
Latest release: v1.2.1
published 9 months ago

Versions: 23
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.5%

Average: 5.7%

Dependent repos count: 5.9%

Last synced: 4 months ago

cran.r-project.org: rerddap

General Purpose Client for 'ERDDAP™' Servers

Homepage: https://docs.ropensci.org/rerddap/
Documentation: http://cran.r-project.org/web/packages/rerddap/rerddap.pdf
License: MIT + file LICENSE
Latest release: 1.2.1
published 9 months ago

Versions: 22
Dependent Packages: 4
Dependent Repositories: 14
Downloads: 1,004 Last month
Docker Downloads: 111,120

Rankings

Docker downloads count: 0.0%

Forks count: 4.6%

Average: 7.2%

Dependent repos count: 7.7%

Stargazers count: 8.0%

Dependent packages count: 9.3%

Downloads: 13.6%

Maintainers (1)

roy.mendelssohn@noaa.gov

Last synced: 5 months ago

Dependencies

DESCRIPTION cran

R >= 2.10 depends
taxize * enhances
crul >= 0.7.4 imports
data.table >= 1.12.0 imports
digest * imports
dplyr >= 0.5.0 imports
hoardr >= 0.5.2 imports
jsonlite >= 1.6 imports
ncdf4 >= 1.16 imports
tibble * imports
utils * imports
xml2 >= 1.2.0 imports
testthat * suggests
vcr >= 0.2.6 suggests

.github/workflows/R-check.yml actions

actions/cache v2 composite
actions/checkout v2 composite
actions/upload-artifact v2 composite
r-lib/actions/setup-pandoc v1 composite
r-lib/actions/setup-r v1 composite

.github/workflows/R-CMD-check.yaml actions

actions/checkout v3 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/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