-
-
Notifications
You must be signed in to change notification settings - Fork 12
/
index.html
279 lines (259 loc) · 16.8 KB
/
index.html
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Web scraper for Atlantic and east Pacific hurricanes and tropical storms • rrricanes</title>
<!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous">
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha256-eZrrJcwDc/3uDhsdt61sL2oOBY362qM3lon1gyExkL0=" crossorigin="anonymous">
<!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script><!-- sticky kit --><script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script><!-- pkgdown --><link href="pkgdown.css" rel="stylesheet">
<script src="pkgdown.js"></script><meta property="og:title" content="Web scraper for Atlantic and east Pacific hurricanes and tropical storms">
<meta property="og:description" content='Get archived data of past and current hurricanes and tropical
storms for the Atlantic and eastern Pacific oceans. Data is available for
storms since 1998. Datasets are updated via the rrricanesdata package.
Currently, this package is about 6MB of datasets. See the README or view
`vignette("drat")` for more information.'>
<meta property="og:image" content="https://ropensci.github.io/rrricanes/logo.png">
<meta name="twitter:card" content="summary">
<!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="container template-article">
<header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="index.html">rrricanes</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.2.0.6.9001</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="index.html">
<span class="fa fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="reference/index.html">Reference</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
Articles
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="articles/accumulated_cyclone_energy.html">Accumulated Cyclone Energy (ACE)</a>
</li>
<li>
<a href="articles/forecast_advisory.html">Forecast/Advisory GIS</a>
</li>
<li>
<a href="articles/getting_started.html">Getting Started</a>
</li>
<li>
<a href="articles/gis_data.html">GIS data</a>
</li>
<li>
<a href="articles/installing_rrricanesdata.html">Installing rrricanesdata</a>
</li>
<li>
<a href="articles/probabilistic_storm_surge.html">Probabilistic Storm Surge</a>
</li>
<li>
<a href="articles/wind_pressure.html">Wind and Pressure</a>
</li>
<li>
<a href="articles/wind_speed_probabilities.html">Wind Speed Probabilities</a>
</li>
</ul>
</li>
<li>
<a href="news/index.html">Changelog</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/ropensci/rrricanes">
<span class="fa fa-github fa-lg"></span>
</a>
</li>
</ul>
</div>
<!--/.nav-collapse -->
</div>
<!--/.container -->
</div>
<!--/.navbar -->
</header><div class="row">
<div class="col-md-9 contents">
<div id="rrricanes" class="section level1">
<div class="page-header"><h1 class="hasAnchor">
<a href="#rrricanes" class="anchor"></a>rrricanes <img src="reference/figures/logo.png" align="right" height="138">
</h1></div>
<p><code>rrricanes</code> is a R library that extracts information from <a href="http://www.nhc.noaa.gov/archive/1998/1998archive.shtml">available archives</a> on past and current tropical cyclones. Currently, archives date back to 1998.</p>
<p>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.</p>
<p>Central Pacific data (140°W to 180°W) is included if issued by the <a href="http://www.nhc.noaa.gov/">National Hurricane Center</a> (generally they’re issued by the <a href="http://www.prh.noaa.gov/cphc/">Central Pacific Hurricane Center</a>).</p>
<p>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.</p>
<p>I wrote this package with the goal of consolidating messy text data into well-organized formats that can easily be saved to CSV, SQL and other data formats.</p>
<p>You may explore some features of the package through the <a href="https://timtrice.shinyapps.io/shinycanes/">shinycanes</a> beta web application (built with R Shiny).</p>
<div id="advisory-products" class="section level2">
<h2 class="hasAnchor">
<a href="#advisory-products" class="anchor"></a>Advisory Products</h2>
<p>Generally speaking, there are five products available for tropical cyclones issued at 03:00, 09:00, 15:00 and 21:00 UTC;</p>
<ol style="list-style-type: decimal">
<li><p>Storm Discussion - These are technical discussions centered on the current structure of the cyclone, satellite presentation, computer forecast model tendencies and more.</p></li>
<li><p>Forecast/Adivsory - This data-rich product lists the current location of the cyclone, its wind structure, forecast and forecast wind structure.</p></li>
<li><p>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.</p></li>
<li><p>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).</p></li>
<li><p>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.</p></li>
</ol>
<p><strong>Discontinued Products</strong></p>
<p>These products are included in the package though they have been discontinued at some point:</p>
<ol style="list-style-type: decimal">
<li><p>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.</p></li>
<li><p>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.</p></li>
</ol>
</div>
<div id="getting-started" class="section level2">
<h2 class="hasAnchor">
<a href="#getting-started" class="anchor"></a>Getting Started</h2>
<p>Please view the vignette ‘Getting Started’:</p>
<div class="sourceCode" id="cb1"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb1-1" data-line-number="1"><span class="kw"><a href="https://www.rdocumentation.org/packages/utils/topics/vignette">vignette</a></span>(<span class="st">"getting_started"</span>, <span class="dt">package =</span> <span class="st">"rrricanes"</span>)</a></code></pre></div>
<p><a href="https://timtrice.github.io/rrricanes/">Online documentation</a> is also available.</p>
<div id="prerequisites" class="section level3">
<h3 class="hasAnchor">
<a href="#prerequisites" class="anchor"></a>Prerequisites</h3>
<p><code>rrricanes</code> requires an active internet connection as data is extracted from online sources.</p>
<p>Linux users must also have the <code>libgdal-dev</code>, <code>libproj-dev</code> and <code>libxml2-dev</code> packages installed.</p>
<p>To add <code>rrricanesdata</code>, a <a href="https://github.com/ropensci/rrricanesdata">package of post-scraped datasets</a>,</p>
<div class="sourceCode" id="cb2"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb2-1" data-line-number="1"><span class="kw"><a href="https://www.rdocumentation.org/packages/utils/topics/install.packages">install.packages</a></span>(<span class="st">"rrricanesdata"</span>, </a>
<a class="sourceLine" id="cb2-2" data-line-number="2"> <span class="dt">repos =</span> <span class="st">"https://timtrice.github.io/drat/"</span>, </a>
<a class="sourceLine" id="cb2-3" data-line-number="3"> <span class="dt">type =</span> <span class="st">"source"</span>)</a></code></pre></div>
<p>To use high resolution tracking maps you will need to install the <code>rnaturalearthhires</code> package.</p>
<div class="sourceCode" id="cb3"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb3-1" data-line-number="1"><span class="kw"><a href="https://www.rdocumentation.org/packages/utils/topics/install.packages">install.packages</a></span>(<span class="st">"rnaturalearthhires"</span>,</a>
<a class="sourceLine" id="cb3-2" data-line-number="2"> <span class="dt">repos =</span> <span class="st">"http://packages.ropensci.org"</span>,</a>
<a class="sourceLine" id="cb3-3" data-line-number="3"> <span class="dt">type =</span> <span class="st">"source"</span>)</a></code></pre></div>
</div>
<div id="installing" class="section level3">
<h3 class="hasAnchor">
<a href="#installing" class="anchor"></a>Installing</h3>
<p><code>rrricanes</code> is currently only available in GitHub. It can be installed using the <code>devtools</code> package:</p>
<div class="sourceCode" id="cb4"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb4-1" data-line-number="1">devtools<span class="op">::</span><span class="kw"><a href="https://www.rdocumentation.org/packages/devtools/topics/reexports">install_github</a></span>(<span class="st">"ropensci/rrricanes"</span>, <span class="dt">build_vignettes =</span> <span class="ot">TRUE</span>)</a></code></pre></div>
</div>
</div>
<div id="built-with" class="section level2">
<h2 class="hasAnchor">
<a href="#built-with" class="anchor"></a>Built With</h2>
<ul>
<li>
<a href="https://www.r-project.org/">R 3.3.3</a> - The R Project for Statistical Computing</li>
</ul>
</div>
<div id="contributing" class="section level2">
<h2 class="hasAnchor">
<a href="#contributing" class="anchor"></a>Contributing</h2>
<p>Please read <a href="https://github.com/ropensci/rrricanes/blob/master/.github/CONTRIBUTING.md">CONTRIBUTING.md</a> for details on our code of conduct, and the process for submitting pull requests to us.</p>
</div>
<div id="versioning" class="section level2">
<h2 class="hasAnchor">
<a href="#versioning" class="anchor"></a>Versioning</h2>
<p>We use <a href="http://semver.org/">SemVer</a> for versioning. For the versions available, see the <a href="https://github.com/ropensci/rrricanes/tags">tags on this repository</a>.</p>
</div>
<div id="authors" class="section level2">
<h2 class="hasAnchor">
<a href="#authors" class="anchor"></a>Authors</h2>
<ul>
<li>
<strong>Tim Trice</strong> - <em>Initial work</em> - <a href="https://github.com/timtrice">timtrice</a>
</li>
</ul>
<p>See also the list of <a href="https://github.com/ropensci/rrricanes/contributors">contributors</a> who participated in this project.</p>
</div>
<div id="license" class="section level2">
<h2 class="hasAnchor">
<a href="#license" class="anchor"></a>License</h2>
<p>This project is licensed under the MIT License - see the <a href="LICENSE.html">LICENSE.md</a> file for details</p>
</div>
<div id="acknowledgments" class="section level2">
<h2 class="hasAnchor">
<a href="#acknowledgments" class="anchor"></a>Acknowledgments</h2>
<ul>
<li><a href="https://github.com/jimmylovestea">Molyneux, James</a></li>
<li><a href="https://github.com/mpadge">Padgham, Mark</a></li>
<li><a href="https://github.com/robinsones">Robinson, Emily</a></li>
<li><a href="https://github.com/hrbrmstr">Rudis, Bob</a></li>
<li><a href="https://github.com/maelle">Salmon, Maëlle</a></li>
<li><a href="https://github.com/jsta">Stachelek, Joseph</a></li>
</ul>
</div>
<div id="known-data-quality-issues" class="section level2">
<h2 class="hasAnchor">
<a href="#known-data-quality-issues" class="anchor"></a>Known Data Quality Issues</h2>
<ol style="list-style-type: decimal">
<li>Hurricane Juan (AL152003), Adv 15; no status leads to improper <code>Status</code> and <code>Name</code> values in some datasets. (<a href="https://github.com/ropensci/rrricanes/issues/82">#82</a>)</li>
</ol>
</div>
</div>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
<div class="links">
<h2>Links</h2>
<ul class="list-unstyled">
<li>Browse source code at <br><a href="https://github.com/ropensci/rrricanes">https://github.com/ropensci/rrricanes</a>
</li>
<li>Report a bug at <br><a href="https://github.com/ropensci/rrricanes/issues">https://github.com/ropensci/rrricanes/issues</a>
</li>
</ul>
</div>
<div class="license">
<h2>License</h2>
<ul class="list-unstyled">
<li>
<a href="https://opensource.org/licenses/mit-license.php">MIT</a> + file <a href="LICENSE-text.html">LICENSE</a>
</li>
</ul>
</div>
<div class="developers">
<h2>Developers</h2>
<ul class="list-unstyled">
<li>Tim Trice <br><small class="roles"> Author, maintainer </small> </li>
<li><a href="authors.html">All authors...</a></li>
</ul>
</div>
<div class="dev-status">
<h2>Dev status</h2>
<ul class="list-unstyled">
<li><a href="https://cran.r-project.org/"><img src="https://img.shields.io/badge/R%3E%3D-3.5.0-6666ff.svg" alt="minimal R version"></a></li>
<li><a href="https://github.com/ropensci/rrricanes/tags"><img src="https://img.shields.io/github/release/ropensci/rrricanes/all.svg" alt="GitHub (pre-)release"></a></li>
<li><a href="https://github.com/ropensci/onboarding/issues/118"><img src="https://badges.ropensci.org/118_status.svg"></a></li>
<li><a href="https://cran.r-project.org/package=rrricanes"><img src="http://www.r-pkg.org/badges/version/rrricanes" alt="CRAN_Status_Badge"></a></li>
<li><a href="https://travis-ci.org/ropensci/rrricanes"><img src="https://img.shields.io/travis/ropensci/rrricanes/master.svg" alt="Build Status"></a></li>
<li><a href="https://ci.appveyor.com/project/timtrice/rrricanes-g4dos"><img src="https://img.shields.io/appveyor/ci/timtrice/rrricanes-g4dos/master.svg" alt="AppVeyor Build Status"></a></li>
<li><a href="https://codecov.io/gh/ropensci/rrricanes"><img src="https://codecov.io/gh/ropensci/rrricanes/branch/master/graph/badge.svg" alt="codecov"></a></li>
</ul>
</div>
</div>
</div>
<footer><div class="copyright">
<p>Developed by Tim Trice.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.3.0.</p>
</div>
</footer>
</div>
</body>
</html>