Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ropensci/rerddap
R client for working with ERDDAP servers
https://github.com/ropensci/rerddap
api-client erddap noaa-data r r-package rstats
Last synced: 3 months ago
JSON representation
R client for working with ERDDAP servers
- Host: GitHub
- URL: https://github.com/ropensci/rerddap
- Owner: ropensci
- License: other
- Created: 2014-11-22T07:58:32.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-01-12T19:50:49.000Z (10 months ago)
- Last Synced: 2024-07-20T00:19:41.177Z (4 months ago)
- Topics: api-client, erddap, noaa-data, r, r-package, rstats
- Language: R
- Homepage: https://docs.ropensci.org/rerddap
- Size: 96.1 MB
- Stars: 40
- Watchers: 5
- Forks: 14
- Open Issues: 2
-
Metadata Files:
- Readme: README.Rmd
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-earthobservation-code - rerddap - `R` client for working with ERDDAP servers [docs](https://docs.ropensci.org/rerddap/) reference the [ERDDAP Server](https://upwell.pfeg.noaa.gov/erddap/index.html) (Resources for `R` / Testing your code)
- awesome-erddap - rerddap - R language package for simplified access to data in any ERDDAP server, can also be installed from CRAN. (ERDDAP Clients)
README
rerddap
=====
```{r echo=FALSE}
knitr::opts_chunk$set(
comment = "#>",
collapse = TRUE,
warning = FALSE,
message = FALSE
)
```
[](https://cranchecks.info/pkgs/rerddap)
[](https://github.com/ropensci/rerddap/actions/workflows/R-CMD-check.yaml)
[](https://codecov.io/github/ropensci/rerddap?branch=master)
[](https://github.com/r-hub/cranlogs.app)
[](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.