Skip to content
/ rnoaa Public

R interface to many NOAA data APIs

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
LICENSE.md
Notifications You must be signed in to change notification settings

ropensci/rnoaa

Repository files navigation

rnoaa

Project Status: Unsupported cran checks R-check codecov.io rstudio mirror downloads cran version

rnoaa is an R interface to many NOAA data sources. We don't cover all of them, but we include many commonly used sources, and add we are always adding new sources. We focus on easy to use interfaces for getting NOAA data, and giving back data in easy to use formats downstream. We currently don't do much in the way of plots or analysis. To get started see: https://docs.ropensci.org/rnoaa/articles/rnoaa.html

NOTICE: PACKAGE TO BE ARCHIVED

NOAA has changed not only the base URL of the API but reorganized the structure and endpoints of the data and API. The current rnoaa package is still functional with the NOAA API v2 but the data available in the API end at approximately 2022-09-15. A new NOAA weather package is planned to replace rnoaa functionality where possible. At that point the rnoaa package will be archived.

Data sources in rnoaa

Help/Getting Started

Documentation is at https://docs.ropensci.org/rnoaa/, and there are many vignettes in the package itself, available in your R session, or on CRAN (https://cran.r-project.org/package=rnoaa). The tutorials:

  • Getting started - start here
  • NOAA Buoy vignette
  • NOAA National Climatic Data Center (NCDC) vignette (examples)
  • NOAA NCDC attributes vignette
  • NOAA NCDC workflow vignette
  • Sea ice vignette
  • Severe Weather Data Inventory (SWDI) vignette
  • Historical Observing Metadata Repository (HOMR) vignette

netcdf data

Some functions use netcdf files, including:

  • ersst
  • buoy
  • bsw
  • argo

You'll need the ncdf4 package for those functions, and those only. ncdf4 is in Suggests in this package, meaning you only need ncdf4 if you are using any of the functions listed above. You'll get an informative error telling you to install ncdf4 if you don't have it and you try to use the those functions. Installation of ncdf4 should be straightforward on any system. See https://cran.r-project.org/package=ncdf4

NOAA NCDC Datasets

There are many NOAA NCDC datasets. All data sources work, except NEXRAD2 and NEXRAD3, for an unknown reason. This relates to ncdc_*() functions only.

Dataset Description Start Date End Date Data Coverage
GHCND Daily Summaries 1763-01-01 2023-04-20 1.00
GSOM Global Summary of the Month 1763-01-01 2023-03-01 1.00
GSOY Global Summary of the Year 1763-01-01 2023-01-01 1.00
NEXRAD2 Weather Radar (Level II) 1991-06-05 2023-04-19 0.95
NEXRAD3 Weather Radar (Level III) 1994-05-20 2023-04-18 0.95
NORMAL_ANN Normals Annual/Seasonal 2010-01-01 2010-01-01 1.00
NORMAL_DLY Normals Daily 2010-01-01 2010-12-31 1.00
NORMAL_HLY Normals Hourly 2010-01-01 2010-12-31 1.00
NORMAL_MLY Normals Monthly 2010-01-01 2010-12-01 1.00
PRECIP_15 Precipitation 15 Minute 1970-05-12 2014-01-01 0.25
PRECIP_HLY Precipitation Hourly 1900-01-01 2014-01-01 1.00
#> table updated on 2023-04-22

NOAA NCDC Attributes

Each NOAA dataset has a different set of attributes that you can potentially get back in your search. See https://www.ncei.noaa.gov/access for detailed info on each dataset. We provide some information on the attributes in this package; see the vignette for attributes (https://docs.ropensci.org/rnoaa/articles/ncdc_attributes.html) to find out more

Contributors

Meta