/
calcBoundaryData.html
224 lines (178 loc) · 10.2 KB
/
calcBoundaryData.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
<!-- 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>Calculate boundary data for planning units — calcBoundaryData • raptr</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 href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.3.7/sandstone/bootstrap.min.css" rel="stylesheet" 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="Calculate boundary data for planning units — calcBoundaryData" />
<meta property="og:description" content="This function calculates boundary length data for
PolySet, SpatialPolygons, and
SpatialPolygonsDataFrame objects. Be aware that this
function is designed with performance in mind, and as a consequence, if this
function is used improperly then it may crash R. Furthermore, multipart
polygons with touching edges will likely result in inaccuracies.
If argument set to SpatialPolygons or
SpatialPolygonsDataFrame, this will be converted to
PolySet before processing." />
<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">raptr</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.1.6</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/raptr.html">Get started</a>
</li>
<li>
<a href="../reference/index.html">Reference</a>
</li>
<li>
<a href="../news/index.html">Changelog</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/jeffreyhanson/raptr">
<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>Calculate boundary data for planning units</h1>
<small class="dont-index">Source: <a href='https://github.com/jeffreyhanson/raptr/blob/master/R/calcBoundaryData.R'><code>R/calcBoundaryData.R</code></a></small>
<div class="hidden name"><code>calcBoundaryData.Rd</code></div>
</div>
<div class="ref-description">
<p>This function calculates boundary length data for
<code><a href='https://www.rdocumentation.org/packages/PBSmapping/topics/PolySet'>PolySet</a></code>, <code><a href='https://www.rdocumentation.org/packages/sp/topics/SpatialPolygons'>SpatialPolygons</a></code>, and
<code><a href='https://www.rdocumentation.org/packages/sp/topics/SpatialPolygons'>SpatialPolygonsDataFrame</a></code> objects. Be aware that this
function is designed with performance in mind, and as a consequence, if this
function is used improperly then it may crash R. Furthermore, multipart
polygons with touching edges will likely result in inaccuracies.
If argument set to <code><a href='https://www.rdocumentation.org/packages/sp/topics/SpatialPolygons'>SpatialPolygons</a></code> or
<code><a href='https://www.rdocumentation.org/packages/sp/topics/SpatialPolygons'>SpatialPolygonsDataFrame</a></code>, this will be converted to
PolySet before processing.</p>
</div>
<pre class="usage"><span class='fu'>calcBoundaryData</span>(<span class='no'>x</span>, <span class='no'>tol</span>, <span class='no'>length.factor</span>, <span class='no'>edge.factor</span>)
<span class='co'># S3 method for PolySet</span>
<span class='fu'>calcBoundaryData</span>(<span class='no'>x</span>, <span class='kw'>tol</span> <span class='kw'>=</span> <span class='fl'>0.001</span>, <span class='kw'>length.factor</span> <span class='kw'>=</span> <span class='fl'>1</span>,
<span class='kw'>edge.factor</span> <span class='kw'>=</span> <span class='fl'>1</span>)
<span class='co'># S3 method for SpatialPolygons</span>
<span class='fu'>calcBoundaryData</span>(<span class='no'>x</span>, <span class='kw'>tol</span> <span class='kw'>=</span> <span class='fl'>0.001</span>,
<span class='kw'>length.factor</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='kw'>edge.factor</span> <span class='kw'>=</span> <span class='fl'>1</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>x</th>
<td><p><code><a href='https://www.rdocumentation.org/packages/PBSmapping/topics/PolySet'>PolySet</a></code>,
<code><a href='https://www.rdocumentation.org/packages/sp/topics/SpatialPolygons'>SpatialPolygons</a></code> or
<code><a href='https://www.rdocumentation.org/packages/sp/topics/SpatialPolygons'>SpatialPolygonsDataFrame</a></code> object.</p></td>
</tr>
<tr>
<th>tol</th>
<td><p><code>numeric</code> to specify precision of calculations. In other
words, how far apart vertices have to be to be considered different?</p></td>
</tr>
<tr>
<th>length.factor</th>
<td><p><code>numeric</code> to scale boundary lengths.</p></td>
</tr>
<tr>
<th>edge.factor</th>
<td><p><code>numeric</code> to scale boundary lengths for edges that
do not have any neighbors, such as those that occur along the margins.</p></td>
</tr>
</table>
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
<p><code>data.frame</code> with 'id1' (<code>integer</code>), 'id2'
(<code>integer</code>), and 'amount' (<code>numeric</code>) columns.</p>
<h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2>
<div class='dont-index'><p>This function is based on the algorithm in QMARXAN
<a href='https://github.com/tsw-apropos/qmarxan'>https://github.com/tsw-apropos/qmarxan</a> for calculating boundary
length.</p></div>
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
<pre class="examples"><div class='input'><span class='co'># simulate planning units</span>
<span class='no'>sim_pus</span> <span class='kw'><-</span> <span class='fu'><a href='sim.pus.html'>sim.pus</a></span>(<span class='fl'>225L</span>)
<span class='co'># calculate boundary data</span>
<span class='no'>bound.dat</span> <span class='kw'><-</span> <span class='fu'>calcBoundaryData</span>(<span class='no'>sim_pus</span>)
<span class='co'># print summary of boundary data</span>
<span class='fu'><a href='summary.html'>summary</a></span>(<span class='no'>bound.dat</span>)</div><div class='output co'>#> id1 id2 boundary
#> Min. : 1.00 Min. : 1.00 Min. :1.000
#> 1st Qu.: 59.75 1st Qu.: 51.75 1st Qu.:1.000
#> Median :117.00 Median :109.00 Median :1.000
#> Mean :116.53 Mean :109.47 Mean :1.008
#> 3rd Qu.:174.25 3rd Qu.:166.25 3rd Qu.:1.000
#> Max. :225.00 Max. :225.00 Max. :2.000 </div><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="#see-also">See also</a></li>
<li><a href="#examples">Examples</a></li>
</ul>
</div>
</div>
<footer>
<div class="copyright">
<p>Developed by <a href='http://jeffrey-hanson.com'>Jeffrey O Hanson</a>, <a href='https://rhodesconservation.com/people/jonathan-rhodes/'>Jonathan R Rhodes</a>, <a href='http://www.possinghamlab.org/people-new/all-lab-members/570-hugh-possingham.html'>Hugh P Possingham</a>, <a href='https://www.fullerlab.org/drrichardfuller/'>Richard A Fuller</a>.</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>