-
Notifications
You must be signed in to change notification settings - Fork 32
/
navigate_nldi.html
256 lines (206 loc) · 14 KB
/
navigate_nldi.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
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html lang="en">
<head>
<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>Navigate NLDI — navigate_nldi • nhdplusTools</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="Navigate NLDI — navigate_nldi" />
<meta property="og:description" content="Navigate the Network Linked Data Index network." />
<meta property="og:image" content="/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-reference-topic">
<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">nhdplusTools</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.3.11</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="../articles/nhdplusTools.html">Get started</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/plot_nhdplus.html">Plotting with nhdplusTools</a>
</li>
<li>
<a href="../articles/point_indexing.html">Indexing and Referencing</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/usgs-r/nhdplusTools">
<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 class="page-header">
<h1>Navigate NLDI</h1>
<small class="dont-index">Source: <a href='https://github.com/usgs-r/nhdplusTools/blob/master/R/get_nldi.R'><code>R/get_nldi.R</code></a></small>
<div class="hidden name"><code>navigate_nldi.Rd</code></div>
</div>
<div class="ref-description">
<p>Navigate the Network Linked Data Index network.</p>
</div>
<pre class="usage"><span class='fu'>navigate_nldi</span>(<span class='no'>nldi_feature</span>, <span class='kw'>mode</span> <span class='kw'>=</span> <span class='st'>"upstreamMain"</span>,
<span class='kw'>data_source</span> <span class='kw'>=</span> <span class='st'>"comid"</span>, <span class='kw'>distance_km</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>tier</span> <span class='kw'>=</span> <span class='st'>"prod"</span>)</pre>
<h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
<table class="ref-arguments">
<colgroup><col class="name" /><col class="desc" /></colgroup>
<tr>
<th>nldi_feature</th>
<td><p>list with names `featureSource` and `featureID` where
`featureSource` is derived from the "source" column of the response of
discover_nldi_sources() and the `featureSource` is a known identifier
from the specified `featureSource`.</p></td>
</tr>
<tr>
<th>mode</th>
<td><p>character chosen from names, URLs, or url parameters
returned by discover_nldi_navigation(nldi_feature). See examples.</p></td>
</tr>
<tr>
<th>data_source</th>
<td><p>character chosen from "source" column of the response
of discover_nldi_sources() or empty string for flowline geometry.</p></td>
</tr>
<tr>
<th>distance_km</th>
<td><p>numeric distance in km to stop navigating.</p></td>
</tr>
<tr>
<th>tier</th>
<td><p>character optional "prod" or "test"</p></td>
</tr>
</table>
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
<p>sf data.frame with result</p>
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
<pre class="examples"><div class='input'><span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/library'>library</a></span>(<span class='no'>sf</span>)</div><div class='output co'>#> <span class='message'>Linking to GEOS 3.7.2, GDAL 2.4.1, PROJ 5.2.0</span></div><div class='input'><span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/library'>library</a></span>(<span class='no'>dplyr</span>)</div><div class='output co'>#> <span class='message'></span>
#> <span class='message'>Attaching package: ‘dplyr’</span></div><div class='output co'>#> <span class='message'>The following object is masked from ‘package:testthat’:</span>
#> <span class='message'></span>
#> <span class='message'> matches</span></div><div class='output co'>#> <span class='message'>The following objects are masked from ‘package:stats’:</span>
#> <span class='message'></span>
#> <span class='message'> filter, lag</span></div><div class='output co'>#> <span class='message'>The following objects are masked from ‘package:base’:</span>
#> <span class='message'></span>
#> <span class='message'> intersect, setdiff, setequal, union</span></div><div class='input'>
<span class='no'>nldi_nwis</span> <span class='kw'><-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/list'>list</a></span>(<span class='kw'>featureSource</span> <span class='kw'>=</span> <span class='st'>"nwissite"</span>, <span class='kw'>featureID</span> <span class='kw'>=</span> <span class='st'>"USGS-05428500"</span>)
<span class='fu'>navigate_nldi</span>(<span class='kw'>nldi_feature</span> <span class='kw'>=</span> <span class='no'>nldi_nwis</span>,
<span class='kw'>mode</span> <span class='kw'>=</span> <span class='st'>"upstreamTributaries"</span>,
<span class='kw'>data_source</span> <span class='kw'>=</span> <span class='st'>""</span>) <span class='kw'>%>%</span>
<span class='fu'><a href='https://www.rdocumentation.org/packages/sf/topics/st_geometry'>st_geometry</a></span>() <span class='kw'>%>%</span>
<span class='fu'><a href='https://www.rdocumentation.org/packages/sf/topics/plot'>plot</a></span>()</div><div class='input'>
<span class='fu'>navigate_nldi</span>(<span class='kw'>nldi_feature</span> <span class='kw'>=</span> <span class='no'>nldi_nwis</span>,
<span class='kw'>mode</span> <span class='kw'>=</span> <span class='st'>"UM"</span>,
<span class='kw'>data_source</span> <span class='kw'>=</span> <span class='st'>""</span>) <span class='kw'>%>%</span>
<span class='fu'><a href='https://www.rdocumentation.org/packages/sf/topics/st_geometry'>st_geometry</a></span>() <span class='kw'>%>%</span>
<span class='fu'><a href='https://www.rdocumentation.org/packages/sf/topics/plot'>plot</a></span>(<span class='kw'>col</span> <span class='kw'>=</span> <span class='st'>"blue"</span>, <span class='kw'>add</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)</div><div class='input'>
<span class='no'>nwissite</span> <span class='kw'><-</span> <span class='fu'>navigate_nldi</span>(<span class='kw'>nldi_feature</span> <span class='kw'>=</span> <span class='no'>nldi_nwis</span>,
<span class='kw'>mode</span> <span class='kw'>=</span> <span class='st'>"UT"</span>,
<span class='kw'>data_source</span> <span class='kw'>=</span> <span class='st'>"nwissite"</span>)
<span class='fu'><a href='https://www.rdocumentation.org/packages/sf/topics/st_geometry'>st_geometry</a></span>(<span class='no'>nwissite</span>) <span class='kw'>%>%</span>
<span class='fu'><a href='https://www.rdocumentation.org/packages/sf/topics/plot'>plot</a></span>(<span class='kw'>col</span> <span class='kw'>=</span> <span class='st'>"green"</span>, <span class='kw'>add</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)</div><div class='img'><img src='navigate_nldi-1.png' alt='' width='700' height='433' /></div><div class='input'>
<span class='no'>nwissite</span></div><div class='output co'>#> Simple feature collection with 13 features and 7 fields
#> geometry type: POINT
#> dimension: XY
#> bbox: xmin: -89.53611 ymin: 43.08944 xmax: -89.3525 ymax: 43.20889
#> epsg (SRID): 4326
#> proj4string: +proj=longlat +datum=WGS84 +no_defs
#> <span style='color: #949494;'># A tibble: 13 x 8</span><span>
#> source sourceName identifier name uri comid navigation
#> </span><span style='color: #949494;font-style: italic;'><chr></span><span> </span><span style='color: #949494;font-style: italic;'><chr></span><span> </span><span style='color: #949494;font-style: italic;'><chr></span><span> </span><span style='color: #949494;font-style: italic;'><chr></span><span> </span><span style='color: #949494;font-style: italic;'><chr></span><span> </span><span style='color: #949494;font-style: italic;'><chr></span><span> </span><span style='color: #949494;font-style: italic;'><chr></span><span>
#> </span><span style='color: #BCBCBC;'> 1</span><span> nwiss… NWIS Sites USGS-0542… SIXM… http… 1329… https://c…
#> </span><span style='color: #BCBCBC;'> 2</span><span> nwiss… NWIS Sites USGS-0542… YAHA… http… 1329… https://c…
#> </span><span style='color: #BCBCBC;'> 3</span><span> nwiss… NWIS Sites USGS-0542… DORN… http… 1329… https://c…
#> </span><span style='color: #BCBCBC;'> 4</span><span> nwiss… NWIS Sites USGS-0542… DORN… http… 1329… https://c…
#> </span><span style='color: #BCBCBC;'> 5</span><span> nwiss… NWIS Sites USGS-0542… YAHA… http… 1329… https://c…
#> </span><span style='color: #BCBCBC;'> 6</span><span> nwiss… NWIS Sites USGS-0542… PHEA… http… 1329… https://c…
#> </span><span style='color: #BCBCBC;'> 7</span><span> nwiss… NWIS Sites USGS-0542… PHEA… http… 1329… https://c…
#> </span><span style='color: #BCBCBC;'> 8</span><span> nwiss… NWIS Sites USGS-0542… S FO… http… 1329… https://c…
#> </span><span style='color: #BCBCBC;'> 9</span><span> nwiss… NWIS Sites USGS-0542… PHEA… http… 1329… https://c…
#> </span><span style='color: #BCBCBC;'>10</span><span> nwiss… NWIS Sites USGS-0542… SIXM… http… 1329… https://c…
#> </span><span style='color: #BCBCBC;'>11</span><span> nwiss… NWIS Sites USGS-0542… SIXM… http… 1329… https://c…
#> </span><span style='color: #BCBCBC;'>12</span><span> nwiss… NWIS Sites USGS-0542… PHEA… http… 1329… https://c…
#> </span><span style='color: #BCBCBC;'>13</span><span> nwiss… NWIS Sites USGS-0542… YAHA… http… 1329… https://c…
#> </span><span style='color: #949494;'># … with 1 more variable: geometry </span><span style='color: #949494;font-style: italic;'><POINT [°]></span><span></div></span><div class='input'>
</div></pre>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
<h2>Contents</h2>
<ul class="nav nav-pills nav-stacked">
<li><a href="#arguments">Arguments</a></li>
<li><a href="#value">Value</a></li>
<li><a href="#examples">Examples</a></li>
</ul>
</div>
</div>
<footer>
<div class="copyright">
<p>Developed by David Blodgett.</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>