Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ropensci/rrricanes

Web scraper for Atlantic and east Pacific hurricanes and tropical storms
https://github.com/ropensci/rrricanes

hurricane peer-reviewed r r-package rstats weather

Last synced: 3 months ago
JSON representation

Web scraper for Atlantic and east Pacific hurricanes and tropical storms

Host: GitHub
URL: https://github.com/ropensci/rrricanes
Owner: ropensci
License: other
Created: 2016-11-28T13:25:12.000Z (almost 8 years ago)
Default Branch: main
Last Pushed: 2023-10-09T18:24:29.000Z (about 1 year ago)
Last Synced: 2024-05-20T06:46:04.838Z (6 months ago)
Topics: hurricane, peer-reviewed, r, r-package, rstats, weather
Language: R
Homepage: https://docs.ropensci.org/rrricanes
Size: 109 MB
Stars: 21
Watchers: 6
Forks: 12
Open Issues: 18
Metadata Files:
- Readme: README.Rmd
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

open-sustainable-technology - rrricanes - An R library that extracts information from Atlantic and east Pacific hurricanes and tropical storms. (Climate Change / Natural Hazard and Storm)

README

---
output: github_document
---

[![minimal R version](https://img.shields.io/badge/R%3E%3D-3.5.0-6666ff.svg)](https://cran.r-project.org/)
[![GitHub (pre-)release](https://img.shields.io/github/release/ropensci/rrricanes/all.svg)](https://github.com/ropensci/rrricanes/tags)
[![](https://badges.ropensci.org/118_status.svg)](https://github.com/ropensci/onboarding/issues/118)
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/rrricanes)](https://cran.r-project.org/package=rrricanes)
[![R-CMD-check](https://github.com/ropensci/rrricanes/workflows/R-CMD-check/badge.svg)](https://github.com/ropensci/rrricanes/actions)
[![codecov](https://codecov.io/gh/ropensci/rrricanes/branch/master/graph/badge.svg)](https://codecov.io/gh/ropensci/rrricanes)

```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```

# rrricanes

`rrricanes` is a R library that extracts information from [available archives](http://www.nhc.noaa.gov/archive/1998/1998archive.shtml) on past and current tropical cyclones. Currently, archives date back to 1998.

Data can be obtained for cyclones in the north Atlantic (considered the Atlantic Basin) and north-eastern Pacific (the East Pacific Basin from 140°W and eastward.

Central Pacific data (140°W to 180°W) is included if issued by the [National Hurricane Center](http://www.nhc.noaa.gov/) (generally they're issued by the [Central Pacific Hurricane Center](http://www.prh.noaa.gov/cphc/)).

This library parses the text advisories of all tropical cyclones since 1998. Over the years the formats of the text products have changed and many are loosely formatted.

## Current Status of rrricanes

rrcanes is not currently on CRAN. A group of people
(who welcome others to join us) are working
on updating the package and get it back into shape
for submission to CRAN. Because it has been
a while we are taking the opportunity to do
some updating and refactoring. Specifically
we are working to get the package working with
the recent [https://r-spatial.org/](changes in
the R spatial ecosystem). When possible we
are also shifting to more modern APIs for
accessing the data when they are available.

Please report any issues and share ideas in the
issue tracker and code with pull requests.

## Package background

This package was created by Time Trice with the goal of consolidating messy
text data into well-organized formats that can easily be saved
to CSV, SQL and other data formats.

## Advisory Products

Generally speaking, there are five products available for tropical cyclones issued at 03:00, 09:00, 15:00 and 21:00 UTC;

1. Storm Discussion - These are technical discussions centered on the current structure of the cyclone, satellite presentation, computer forecast model tendencies and more.

2. Forecast/Adivsory - This data-rich product lists the current location of the cyclone, its wind structure, forecast and forecast wind structure.

3. Public Advisory - These are general text statements issued for the public-at-large. Information in these products is a summary of the Forecast/Advisory product along with any watches and warnings issued, changed, or cancelled. Public Advisory products are the only regularly-scheduled product that may be issued intermittently (every three hours and, occasionally, every two hours) when watches and warnings are in effect.

4. Wind Speed Probabilities - These products list the probability of a minimum sustained wind speed expected in a given forecast window. This product replaces the Strike Probabilities product beginning in 2006 (see below).

5. Updates - Tropical Cyclone Updates may be issued at any time if a storm is an immediate threat to land or if the cyclone undergoes a significant change of strength or structure. The information in this product is general.

__Discontinued Products__

These products are included in the package though they have been discontinued at some point:

1. Strike Probabilities - List the probability of a tropical cyclone passing within 65 nautical miles of a location within a forecast window. Replaced in 2006 by the Wind Speed Probabilities product.

2. Position Estimates - Typically issued as a storm is threatening land but generally rare (see Hurricane Ike 2008, Key AL092008). It is generally just an update of the current location of the cyclone. After the 2011 hurricane season, this product was discontinued; Updates are now issued in their place.

**Note that the discontinued products are historical only
and eventually we will create

## Getting Started

Please view the vignette 'Getting Started':

```r
vignette("getting_started", package = "rrricanes")
```

[Online documentation](https://timtrice.github.io/rrricanes/) is also available.

### Prerequisites

`rrricanes` requires an active internet connection as data is extracted from online sources.

Linux users must also have the `libgdal-dev`, `libproj-dev` and `libxml2-dev` packages installed.

To add `rrricanesdata`, a [package of post-scraped datasets](https://github.com/ropensci/rrricanesdata),

```r
install.packages("rrricanesdata",
repos = "https://timtrice.github.io/drat/",
type = "source")
```
However this package is not currently maintained.

To use high resolution tracking maps you will need to install the `rnaturalearthhires` package.

```r
install.packages("rnaturalearthhires",
repos = "http://packages.ropensci.org",
type = "source")
```

### Installing

`rrricanes` is currently only available in GitHub. It can be installed using the `devtools` package:

```r
devtools::install_github("ropensci/rrricanes", build_vignettes = TRUE)
```

## Built With

* [R 4.1](https://www.r-project.org/) - The R Project for Statistical Computing

New minimum versions for a number of dependencies have been establised.
This provides opportunity to build on newer features of the packages

## Contributing

Please read [CONTRIBUTING.md](https://github.com/ropensci/rrricanes/blob/master/.github/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/ropensci/rrricanes/tags).

## Authors

* **Tim Trice** - *Initial work* - [timtrice](https://github.com/timtrice)

See also the list of [contributors](https://github.com/ropensci/rrricanes/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## Acknowledgments

* [Molyneux, James](https://github.com/jimmylovestea)
* [Padgham, Mark](https://github.com/mpadge)
* [Robinson, Emily](https://github.com/robinsones)
* [Rudis, Bob](https://github.com/hrbrmstr)
* [Salmon, Maëlle](https://github.com/maelle)
* [Stachelek, Joseph](https://github.com/jsta)

## Known Data Quality Issues

1. Hurricane Juan (AL152003), Adv 15; no status leads to improper `Status` and `Name` values in some datasets. ([#82](https://github.com/ropensci/rrricanes/issues/82))