-
Notifications
You must be signed in to change notification settings - Fork 42
/
setResource.html
355 lines (293 loc) · 14.3 KB
/
setResource.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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
<!-- 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>Set up resource — setResource • mizer</title>
<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/cerulean/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script>
<!-- bootstrap-toc -->
<link rel="stylesheet" href="../bootstrap-toc.css">
<script src="../bootstrap-toc.js"></script>
<!-- Font Awesome icons -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous" />
<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script>
<!-- headroom.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script>
<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>
<!-- docsearch -->
<script src="../docsearch.js"></script>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/docsearch.js/2.6.3/docsearch.min.css" integrity="sha256-QOSRU/ra9ActyXkIBbiIB144aDBdtvXBcNc3OTNuX/Q=" crossorigin="anonymous" />
<link href="../docsearch.css" rel="stylesheet">
<script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/jquery.mark.min.js" integrity="sha256-4HLtjeVgH0eIB3aZ9mLYF6E8oU5chNdjU6p6rrXpl9U=" crossorigin="anonymous"></script>
<meta property="og:title" content="Set up resource — setResource" />
<meta property="og:description" content="Sets the intrinsic resource growth rate and the intrinsic resource carrying
capacity as well as the name of the function used to simulate the resource
dynamics" />
<!-- 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 data-spy="scroll" data-target="#toc">
<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">mizer</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">2.0.3</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="../index.html">
<span class="fas fa fas fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="../articles/mizer.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/model_description.html">The General Mizer Size-spectrum Model</a>
</li>
<li>
<a href="../articles/community_model.html">The Community Model</a>
</li>
<li>
<a href="../articles/trait_model.html">The Trait-Based Model</a>
</li>
<li>
<a href="../articles/multispecies_model.html">The Multi Species Model</a>
</li>
<li>
<a href="../articles/running_a_simulation.html">Running a Simulation</a>
</li>
<li>
<a href="../articles/exploring_the_simulation_results.html">Exploring the Simulation Results</a>
</li>
<li>
<a href="../articles/a_multispecies_model_of_the_north_sea.html">A Multi-Species Model Of The North Sea</a>
</li>
<li>
<a href="../articles/plotting.html">Using ggplot2 and plotly with mizer</a>
</li>
<li class="divider"></li>
<li class="dropdown-header">For developers</li>
<li>
<a href="../articles/developer_vignette.html">Developer Guide</a>
</li>
<li>
<a href="../articles/working_with_git.html">Working with git and GitHub</a>
</li>
<li>
<a href="../articles/developer_FAQ.html">Developer FAQ</a>
</li>
<li>
<a href="../articles/editing_website.html">Editing the Mizer Website</a>
</li>
</ul>
</li>
<li>
<a href="../articles/publications.html">Publications</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/sizespectrum/mizer/">
<span class="fab fa fab fa-github fa-lg"></span>
</a>
</li>
</ul>
<form class="navbar-form navbar-right hidden-xs hidden-sm" role="search">
<div class="form-group">
<input type="search" class="form-control" name="search-input" id="search-input" placeholder="Search..." aria-label="Search for..." autocomplete="off">
</div>
</form>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header>
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Set up resource</h1>
<small class="dont-index">Source: <a href='https://github.com/sizespectrum/mizer/blob/master/R/setResource.R'><code>R/setResource.R</code></a></small>
<div class="hidden name"><code>setResource.Rd</code></div>
</div>
<div class="ref-description">
<p>Sets the intrinsic resource growth rate and the intrinsic resource carrying
capacity as well as the name of the function used to simulate the resource
dynamics</p>
</div>
<pre class="usage"><span class='fu'>setResource</span>(
<span class='no'>params</span>,
<span class='kw'>resource_rate</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
<span class='kw'>resource_capacity</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
<span class='kw'>r_pp</span> <span class='kw'>=</span> <span class='fu'>resource_params</span>(<span class='no'>params</span>)<span class='kw'>[[</span><span class='st'>"r_pp"</span>]],
<span class='kw'>kappa</span> <span class='kw'>=</span> <span class='fu'>resource_params</span>(<span class='no'>params</span>)<span class='kw'>[[</span><span class='st'>"kappa"</span>]],
<span class='kw'>lambda</span> <span class='kw'>=</span> <span class='fu'>resource_params</span>(<span class='no'>params</span>)<span class='kw'>[[</span><span class='st'>"lambda"</span>]],
<span class='kw'>n</span> <span class='kw'>=</span> <span class='fu'>resource_params</span>(<span class='no'>params</span>)<span class='kw'>[[</span><span class='st'>"n"</span>]],
<span class='kw'>w_pp_cutoff</span> <span class='kw'>=</span> <span class='fu'>resource_params</span>(<span class='no'>params</span>)<span class='kw'>[[</span><span class='st'>"w_pp_cutoff"</span>]],
<span class='kw'>resource_dynamics</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
<span class='no'>...</span>
)
<span class='fu'>getResourceRate</span>(<span class='no'>params</span>)
<span class='fu'>getResourceCapacity</span>(<span class='no'>params</span>)
<span class='fu'>getResourceDynamics</span>(<span class='no'>params</span>)
<span class='fu'>resource_params</span>(<span class='no'>params</span>)
<span class='fu'>resource_params</span>(<span class='no'>params</span>) <span class='kw'><-</span> <span class='no'>value</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>params</th>
<td><p>A MizerParams object</p></td>
</tr>
<tr>
<th>resource_rate</th>
<td><p>Optional. Vector of resource intrinsic birth rates</p></td>
</tr>
<tr>
<th>resource_capacity</th>
<td><p>Optional. Vector of resource intrinsic carrying capacity</p></td>
</tr>
<tr>
<th>r_pp</th>
<td><p>Coefficient of the intrinsic resource birth rate</p></td>
</tr>
<tr>
<th>kappa</th>
<td><p>Coefficient of the intrinsic resource carrying capacity</p></td>
</tr>
<tr>
<th>lambda</th>
<td><p>Scaling exponent of the intrinsic resource carrying capacity</p></td>
</tr>
<tr>
<th>n</th>
<td><p>Allometric growth exponent for resource</p></td>
</tr>
<tr>
<th>w_pp_cutoff</th>
<td><p>The upper cut off size of the resource spectrum.
Default is 10 g.</p></td>
</tr>
<tr>
<th>resource_dynamics</th>
<td><p>Function that determines resource dynamics by
calculating the resource spectrum at the next time step from the current
state.</p></td>
</tr>
<tr>
<th>...</th>
<td><p>Unused</p></td>
</tr>
<tr>
<th>value</th>
<td><p>List of resource parameters</p></td>
</tr>
</table>
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
<p>A MizerParams object with updated resource parameters. Because of the
way the R language works, <code>setResource()</code> does not make the changes to the
params object that you pass to it but instead returns a new params object.
So to affect the change you call the function in the form
<code>params <- setResource(params, ...)</code>.</p>
<h2 class="hasAnchor" id="setting-resource-dynamics"><a class="anchor" href="#setting-resource-dynamics"></a>Setting resource dynamics</h2>
<p>By default, mizer uses a semichemostat model to describe the resource
dynamics in each size class independently. This semichemostat dynamics is implemented
by the function <code><a href='resource_semichemostat.html'>resource_semichemostat()</a></code>. You can change the
resource dynamics by writing your own function, modelled on
<code><a href='resource_semichemostat.html'>resource_semichemostat()</a></code>, and then passing the name of your
function in the <code>resource_dynamics</code> argument.</p>
<p>The <code>resource_rate</code> argument is a vector specifying the intrinsic resource
growth rate for each size class. If it is not supplied, then the intrinsic growth
rate \(r(w)\) at size \(w\)
is set to $$r(w) = r_{pp}\, w^{n-1}.$$
The values of \(r_{pp}\) and \(n\) are taken from the <code>r_pp</code>
and <code>n</code> arguments.</p>
<p>The <code>resource_capacity</code> argument is a vector specifying the intrinsic resource
carrying capacity for each size class. If it is not supplied, then the
intrinsic carrying capacity \(c(w)\) at size \(w\)
is set to $$c(w) = \kappa\, w^{-\lambda}$$
for all \(w\) less than <code>w_pp_cutoff</code> and zero for larger sizes.
The values of \(\kappa\) and \(\lambda\) are taken from the <code>kappa</code>
and <code>lambda</code> arguments.</p>
<h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2>
<div class='dont-index'><p>Other functions for setting parameters:
<code><a href='setExtMort.html'>setExtMort</a>()</code>,
<code><a href='setFishing.html'>setFishing</a>()</code>,
<code><a href='setInitialValues.html'>setInitialValues</a>()</code>,
<code><a href='setInteraction.html'>setInteraction</a>()</code>,
<code><a href='setMaxIntakeRate.html'>setMaxIntakeRate</a>()</code>,
<code><a href='setMetabolicRate.html'>setMetabolicRate</a>()</code>,
<code><a href='setPredKernel.html'>setPredKernel</a>()</code>,
<code><a href='setReproduction.html'>setReproduction</a>()</code>,
<code><a href='setSearchVolume.html'>setSearchVolume</a>()</code>,
<code><a href='setParams.html'>species_params</a>()</code></p></div>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
<nav id="toc" data-toggle="toc" class="sticky-top">
<h2 data-toc-skip>Contents</h2>
</nav>
</div>
</div>
<footer>
<div class="copyright">
<p>Developed by <a href='https://www.york.ac.uk/maths/staff/gustav-delius/'>Gustav Delius</a>, Finlay Scott, <a href='http://www.utas.edu.au/profiles/staff/imas/julia-blanchard'>Julia Blanchard</a>, <a href='https://ken.haste.dk/'>Ken Andersen</a>.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.5.1.</p>
</div>
</footer>
</div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/docsearch.js/2.6.1/docsearch.min.js" integrity="sha256-GKvGqXDznoRYHCwKXGnuchvKSwmx9SRMrZOTh2g4Sb0=" crossorigin="anonymous"></script>
<script>
docsearch({
apiKey: '96e9641255d3fff35a4fd16d1a1bf70c',
indexName: 'sizespectrum_mizer',
inputSelector: 'input#search-input.form-control',
transformData: function(hits) {
return hits.map(function (hit) {
hit.url = updateHitURL(hit);
return hit;
});
}
});
</script>
</body>
</html>