-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.Rmd
258 lines (215 loc) · 9.69 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
---
output: github_document
---
[](https://cran.r-project.org/)
[](https://github.com/ropensci/rrricanesdata/tags)
[](https://github.com/ropensci/onboarding/issues/118)
[](https://cran.r-project.org/package=rrricanesdata)
[](https://travis-ci.org/ropensci/rrricanesdata)
[](https://ci.appveyor.com/project/timtrice/rrricanesdata-on6xt)
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
# rrricanesdata
`rrricanesdata` is the complementary dataset for [rrricanes](https://github.com/ropensci/rrricanes). Currently it contains all product datasets for every cyclone that has developed in the north Atlantic and northeast Pacific basins since 1998.
`rrricanesdata` will be updated on the first of every month.
## Prerequisites
No prerequisites.
## Installing
`rrricanesdata` can be installed with the following command:
```r
install.packages("rrricanesdata",
repos = "https://timtrice.github.io/drat/",
type = "source")
```
This package is not nor will be made available in CRAN.
### Updating
As `rrricanesdata` will be updated monthly (provided any advisory was issued the previous month), you will want to ensure you have the latest datasets prior to running any analysis. You need to add the package repository to your `repos` options, such as:
```r
options(repos = c(getOption("repos"), "https://timtrice.github.io/drat/")
```
You can then run `update.packages` to check for and install any new updates.
## Datasets
### adv
* Key: Unique identifier of cyclone
* Adv: Advisory number
* Date: Date and time of advisory
* Status: Classification of cyclone
* Name: Name of cyclone
* Lat: Latitude of cyclone center
* Lon: Longitude of cyclone center
* Wind: Maximum sustained one-minute winds in knots
* Gust: Maximum sustained one-minute gusts in knots
* Pressure: Minimum central pressure in millibars
* PosAcc: Position accuracy of cyclone in nautical miles
* FwdDir: Compass angle of forward motion
* FwdSpeed: Forward speed in miles per hour
* Eye: Size of eye in nautical miles
* SeasNE: Radius of 12ft seas in northeast quadrant
* SeasSE: Radius of 12ft seas in southeast quadrant
* SeasSW: Radius of 12ft seas in southwest quadrant
* SeasNW: Radius of 12ft seas in northwest quadrant
### discus
* Status: Classification of storm, e.g., Tropical Storm, Hurricane,
etc.
* Name: Name of storm
* Adv: Advisory Number
* Date: Date of advisory issuance
* Key: ID of cyclone
* Contents: Text content of product
### fcst
* Key: Unique identifier of cyclone
* Adv: Advisory number
* Date: Date and time of advisory
* FcstDate: Forecast date and time in UTC
* Lat: Forecast latitude
* Lon: Forecast Longitude
* Wind: Forecast wind in knots
* Gust: Forecast gust in knots
### fcst_wr
* Key: Unique identifier of cyclone
* Adv: Advisory number
* Date: Date and time of advisory
* FcstDate: Forecast date and time in UTC
* WindField: Minimum sustained wind field for quadrants
* NE: Radius in nautical miles for northeast quadrant
* SE: Radius in nautical miles for southeast quadrant
* SW: Radius in nautical miles for southwest quadrant
* NW: Radius in nautical miles for northwest quadrant
### fstadv
* Status: Classification of cyclone
* Name: Name of cyclone
* Adv: Advisory number
* Date: Date and time of advisory
* Key: Unique identifier of cyclone
* Lat: Latitude of cyclone center
* Lon: Longitude of cyclone center
* Wind: Maximum sustained one-minute winds in knots
* Gust: Maximum sustained one-minute gusts in knots
* Pressure: Minimum central pressure in millibars
* PosAcc: Position accuracy of cyclone in nautical miles
* FwdDir: Compass angle of forward motion
* FwdSpeed: Forward speed in miles per hour
* Eye: Size of eye in nautical miles
* NE64: Radius of >=64kt winds in northeast quadrant
* SE64: Radius of >=64kt winds in southeast quadrant
* SW64: Radius of >=64kt winds in southwest quadrant
* NW64: Radius of >=64kt winds in northwest quadrant
* NE50: Radius of >=50kt winds in northeast quadrant
* SE50: Radius of >=50kt winds in southeast quadrant
* SW50: Radius of >=50kt winds in southwest quadrant
* NW50: Radius of >=50kt winds in northwest quadrant
* NE34: Radius of >=34kt winds in northwest quadrant
* SE34: Radius of >=34kt winds in southeast quadrant
* SW34: Radius of >=34kt winds in southwest quadrant
* NW34: Radius of >=34kt winds in northwest quadrant
* Hr\{n\}FcstDate: Forecast valid date
* Hr\{n\}Lat: Forecast latitude in n hours
* Hr\{n\}Lon: Forecast longitude in n hours
* Hr\{n\}Wind: Forecast maximum wind in n hours
* Hr\{n\}Gust: Forecast maximum gust in n hours
* Hr\{n\}NE64: Forecast wind radius in n hours
* Hr\{n\}SE64: Forecast wind radius in n hours
* Hr\{n\}SW64: Forecast wind radius in n hours
* Hr\{n\}NW64: Forecast wind radius in n hours
* Hr\{n\}NE50: Forecast wind radius in n hours
* Hr\{n\}SE50: Forecast wind radius in n hours
* Hr\{n\}SW50: Forecast wind radius in n hours
* Hr\{n\}NW50: Forecast wind radius in n hours
* Hr\{n\}NE34: Forecast wind radius in n hours
* Hr\{n\}SE34: Forecast wind radius in n hours
* Hr\{n\}SW34: Forecast wind radius in n hours
* Hr\{n\}NW34: Forecast wind radius in n hours
* SeasNE: Radius of 12ft seas in northeast quadrant
* SeasSE: Radius of 12ft seas in southeast quadrant
* SeasSW: Radius of 12ft seas in southwest quadrant
* SeasNW: Radius of 12ft seas in northwest quadrant
### posest
* Status: Classification of storm, e.g., Tropical Storm, Hurricane,
etc.
* Name: Name of storm
* Date: Date of advisory issuance
* Contents: Text content of product
### prblty
* Status: Classification of storm, e.g., Tropical Storm, Hurricane,
etc.
* Name: Name of storm
* Adv: Advisory Number
* Date: Date of advisory issuance
* Location: Location for which the probability statistics rely
* A: Probability of a strike within the next 12 hours
* B: Probability of a strike between 12 and 24 hours
* C: Probability of a strike between 24 and 36 hours
* D: Probability of a strike between 36 and 48 hours
* E: Probability of a strike between 48 and 72 hours
### public
* Status: Classification of storm, e.g., Tropical Storm, Hurricane,
etc.
* Name: Name of storm
* Adv: Advisory Number
* Date: Date of advisory issuance
* Key: Unique ID of the cyclone
* Contents: Text content of product
### storms
* Key: Storm ID
* Name: Storm name
* Wind: Peak wind speed in knots
* StartDate: Date/time of first advisory
* EndDate: Date/time of last advisory
### update
* Status: Classification of storm, e.g., Tropical Storm, Hurricane,
etc.
* Name: Name of storm
* Date: Date of advisory issuance
* Key: Unique ID of cyclone
* Contents: Text content of product
### wndprb
* Status: Classification of storm, e.g., Tropical Storm, Hurricane,
etc.
* Name: Name of storm
* Adv: Advisory Number
* Date: Date of advisory issuance
* Wind: Minimum wind speed for which probabilities reference
* Wind12: Probability of sustained Wind within 12 hours
* Wind24: Probability of sustained Wind within 24 hours
* Wind24Cum: Cumulative probability through 24 hours
* Wind36: Probability of sustained Wind within 36 hours
* Wind36Cum: Cumulative probability through 36 hours
* Wind48: Probability of sustained Wind within 48 hours
* Wind48Cum: Cumulative probability through 48 hours
* Wind72: Probability of sustained Wind within 72 hours
* Wind72Cum: Cumulative probability through 72 hours
* Wind96: Probability of sustained Wind within 96 hours
* Wind96Cum: Cumulative probability through 96 hours
* Wind120: Probability of sustained Wind within 120 hours
* Wind120Cum: Cumulative probability through 120 hours
### wr
* Key: Unique identifier of cyclone
* Adv: Advisory number
* Date: Date and time of advisory
* Windfield: Minimum wind speed expected
* NE: Radius of Windfield in the northeast quadrant
* SE: Radius of Windfield in the southeast quadrant
* SW: Radius of Windfield in the southwest quadrant
* NW: Radius of Windfield in the northwest quadrant
## Built With
* [R 3.3.3](https://www.r-project.org/) - The R Project for Statistical Computing
## Contributing
Please read [CONTRIBUTING.md](https://github.com/ropensci/rrricanesdata/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/rrricanesdata/tags).
## Authors
* **Tim Trice** - *Initial work* - [timtrice](https://github.com/timtrice)
See also the list of [contributors](https://github.com/ropensci/rrricanesdata/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
* [Salmon, Maëlle](https://github.com/maelle)
* [Stachelek, Joseph](https://github.com/jsta)
* [Robinson, Emily](https://github.com/robinsones)
## 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))