-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathREADME.html
More file actions
623 lines (602 loc) · 30 KB
/
Copy pathREADME.html
File metadata and controls
623 lines (602 loc) · 30 KB
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
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
<meta charset="utf-8">
<meta name="generator" content="quarto-1.7.31">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
<title>readme</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
div.columns{display: flex; gap: min(4vw, 1.5em);}
div.column{flex: auto; overflow-x: auto;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
ul.task-list{list-style: none;}
ul.task-list li input[type="checkbox"] {
width: 0.8em;
margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */
vertical-align: middle;
}
</style>
<script src="README_files/libs/clipboard/clipboard.min.js"></script>
<script src="README_files/libs/quarto-html/quarto.js" type="module"></script>
<script src="README_files/libs/quarto-html/tabsets/tabsets.js" type="module"></script>
<script src="README_files/libs/quarto-html/popper.min.js"></script>
<script src="README_files/libs/quarto-html/tippy.umd.min.js"></script>
<script src="README_files/libs/quarto-html/anchor.min.js"></script>
<link href="README_files/libs/quarto-html/tippy.css" rel="stylesheet">
<link href="README_files/libs/quarto-html/quarto-syntax-highlighting-e1a5c8363afafaef2c763b6775fbf3ca.css" rel="stylesheet" id="quarto-text-highlighting-styles">
<script src="README_files/libs/bootstrap/bootstrap.min.js"></script>
<link href="README_files/libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
<link href="README_files/libs/bootstrap/bootstrap-81267100e462c21b3d6c0d5bf76a3417.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<script src="https://cdnjs.cloudflare.com/polyfill/v3/polyfill.min.js?features=es6"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml-full.js" type="text/javascript"></script>
<script type="text/javascript">
const typesetMath = (el) => {
if (window.MathJax) {
// MathJax Typeset
window.MathJax.typeset([el]);
} else if (window.katex) {
// KaTeX Render
var mathElements = el.getElementsByClassName("math");
var macros = [];
for (var i = 0; i < mathElements.length; i++) {
var texText = mathElements[i].firstChild;
if (mathElements[i].tagName == "SPAN") {
window.katex.render(texText.data, mathElements[i], {
displayMode: mathElements[i].classList.contains('display'),
throwOnError: false,
macros: macros,
fleqn: false
});
}
}
}
}
window.Quarto = {
typesetMath
};
</script>
</head>
<body class="fullcontent quarto-light">
<div id="quarto-content" class="page-columns page-rows-contents page-layout-article">
<main class="content" id="quarto-document-content">
<p><a href="https://rodmarsh.github.io/shinyWindowVariance/"><img src="https://img.shields.io/badge/Launch-app-blue?style=for-the-badge&logo=R.png" class="img-fluid" alt="Launch App"></a> <em>(Cmd/Ctrl + Click to open in a new tab)</em></p>
<section id="the-relativity-of-hydrologic-stress" class="level1">
<h1>The relativity of hydrologic stress</h1>
<p>An interactive R Shiny toy model for exploring the statistical properties of <strong>hydrologic stress</strong> as defined by Nathan et al. (2019).</p>
<p>This tool shows that “stress” is not simply a measure of physical flow alteration — it is a statistical relationship between the magnitude of alteration and the natural variability of the system over a specific timeframe.</p>
<section id="overview" class="level2">
<h2 class="anchored" data-anchor-id="overview">Overview</h2>
<p>Nathan et al. (2019) suggest one way to calculate hydrological “stress” from flow alteration is to compare the distribution of system behaviour under baseline conditions against altered conditions:</p>
<blockquote class="blockquote">
<p>The key concept involved is to characterise “hydrologic stress” relative to the range of behaviour encountered under baseline conditions […] If the range of future behaviour lies largely within the range encountered under baseline conditions, then it can be concluded that the additional stress on the system due to climate change is low.</p>
</blockquote>
<p>However, implementations of Nathan et al.’s “stress score” (e.g. John et al., 2023; Morden et al., 2025) often apply a sliding window to calculate the relevant indicator of hydrological alteration (e.g. mean annual flows) through time. This introduces a statistical artefact that this model explores: window dependency.</p>
<p>Users should be aware of a mathematical property of this score: the stress score is dependent on the window length used to calculate the flow metric.</p>
</section>
<section id="interpreting-window-dependency-sample-size-vs-averaging" class="level2">
<h2 class="anchored" data-anchor-id="interpreting-window-dependency-sample-size-vs-averaging">Interpreting window dependency: sample size vs averaging</h2>
<p>It is important to distinguish between two different “n” effects:</p>
<p>A. Increasing the number of independent samples from the same distribution. With more observations, estimates become more precise, but the underlying distribution does not change.</p>
<p>B. Changing the variance of the metric itself through temporal averaging. When indicators are calculated over rolling windows (e.g. 5-, 10-, or 30-year means), the variability of the metric decreases as window length increases (approximately proportional to 1/, accounting for serial correlation).</p>
<table class="caption-top table">
<colgroup>
<col style="width: 25%">
<col style="width: 25%">
<col style="width: 25%">
<col style="width: 25%">
</colgroup>
<thead>
<tr class="header">
<th style="text-align: left;">Window length</th>
<th style="text-align: left;">Variance (noise)</th>
<th style="text-align: left;">Distribution overlap</th>
<th style="text-align: left;">Stress score</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td style="text-align: left;"><strong>Short</strong> (e.g. 5 years)</td>
<td style="text-align: left;">Higher</td>
<td style="text-align: left;">Higher</td>
<td style="text-align: left;">Lower</td>
</tr>
<tr class="even">
<td style="text-align: left;"><strong>Long</strong> (e.g. 30 years)</td>
<td style="text-align: left;">Lower</td>
<td style="text-align: left;">Lower</td>
<td style="text-align: left;">Higher</td>
</tr>
</tbody>
</table>
<p>The window dependency demonstrated in this model arises from (B), not (A). The issue is not that more data are being used, but that averaging changes the variance of the indicator itself.</p>
</section>
<section id="what-the-model-shows" class="level2">
<h2 class="anchored" data-anchor-id="what-the-model-shows">What the model shows</h2>
<p>Nathan et al.’s stress formulation compares the distribution of an indicator under baseline and altered conditions. In practice, this means stress depends on the ratio:</p>
<p>where: - is the shift between baseline and scenario, - is the variability of the indicator.</p>
<p>When rolling windows are used, decreases mechanically as window length increases. Even if the physical alteration remains constant, the ratio /increases. As a result, stress scores rise with window length.</p>
<p>This behaviour is not specific to any single test. Whether overlap-based metrics, rank-based measures, or distributional distances (e.g. Kuiper’s statistic) are used, all depend in some way on the relative separation of distributions. If averaging reduces variability, apparent separation increases.</p>
<p>The underlying issue is therefore not the choice of metric, but the temporal aggregation applied to the indicator.</p>
<p>The key point is not that the stress metric is “wrong,” but that it is sensitive to analyst-defined temporal aggregation. Window length changes the statistical lens through which alteration is viewed, and this can materially alter the interpretation of stress.</p>
<section id="literature-context" class="level3">
<h3 class="anchored" data-anchor-id="literature-context">Literature context</h3>
<p>Studies using this metric shoukd align the window length with a biological or engineering reality, rather than choosing it arbitrarily.</p>
<p><strong>Nathan et al. (2019)</strong> explicitly note the need for a “characteristic period”:</p>
<blockquote class="blockquote">
<p>The relevant period for some short-lived fish might be 1 year while that for long-lived fish, or riparian wetland systems, may be 15 years or longer.</p>
</blockquote>
<p><strong>John et al. (2023)</strong> mathematically confirm the impact of shorter windows:</p>
<blockquote class="blockquote">
<p>Metrics calculated over shorter hydroclimatic sequences are inherently more variable than those calculated over longer sequences […] This suggests that a larger climate-induced change may be required for shorter sequences before the signal becomes dominant.</p>
</blockquote>
</section>
</section>
<section id="using-the-model" class="level2">
<h2 class="anchored" data-anchor-id="using-the-model">Using the model</h2>
<section id="the-ghosting-comparison" class="level3">
<h3 class="anchored" data-anchor-id="the-ghosting-comparison">The “ghosting” comparison</h3>
<p>This feature allows you to visualise the sensitivity of the stress score to the window length.</p>
<ol type="1">
<li>Set the <strong>Rolling Window</strong> to <strong>5 years</strong> (high variability).</li>
<li>Click <strong>Ghost Current View</strong>. A dashed line will freeze this “high noise” state.</li>
<li>Move the <strong>Rolling Window</strong> to <strong>30 years</strong>.</li>
<li><strong>Compare:</strong> Observe how the solid lines (30-year) narrow and pull apart compared to the ghosted lines (5-year). The jump in the stress score shows the emergence of the signal from noise.</li>
</ol>
</section>
</section>
<section id="technical-implementation" class="level2">
<h2 class="anchored" data-anchor-id="technical-implementation">Technical implementation</h2>
<p>The simulation generates synthetic river data using an additive noise model with linear non-stationarity.</p>
<section id="flow-generation" class="level3">
<h3 class="anchored" data-anchor-id="flow-generation">Flow generation</h3>
<p>The “baseline” and “post-withdrawal” time series are constructed as:</p>
<p><span class="math display">\[Q_{\text{nat}}(t) = \mu_{\text{base}} + (\text{Trend} \times t) + \text{Noise}(t)\]</span></p>
<p><span class="math display">\[Q_{\text{post}}(t) = Q_{\text{nat}}(t) - \text{Gap}\]</span></p>
<p>where:</p>
<ul>
<li><strong>Base flow</strong> (<span class="math inline">\(\mu_{\text{base}}\)</span>) — fixed at 60 units.</li>
<li><strong>Trend</strong> — linear gain or loss (−0.5 to +0.5 units/month) representing non-stationarity (e.g. climate drying or wetting).</li>
<li><strong>Gap</strong> — constant subtraction representing the signal (human withdrawal).</li>
</ul>
</section>
<section id="the-noise-function" class="level3">
<h3 class="anchored" data-anchor-id="the-noise-function">The noise function</h3>
<p>The noise term <span class="math inline">\(\text{Noise}(t)\)</span> is generated to ensure statistical control. Regardless of the chosen distribution shape, the noise is centred and scaled to match the user-defined sigma (<span class="math inline">\(\sigma\)</span>):</p>
<p><span class="math display">\[\text{Noise} = (X - \bar{X}) \times \frac{\sigma}{\text{sd}(X)}\]</span></p>
<p>This ensures that changing the distribution <em>shape</em> does not accidentally change the <em>magnitude</em> of the variance, allowing for a fair comparison of how skewness affects signal detection.</p>
</section>
<section id="available-distributions" class="level3">
<h3 class="anchored" data-anchor-id="available-distributions">Available distributions</h3>
<p>Users can toggle the underlying probability distribution of the noise to test robustness:</p>
<ul>
<li><strong>Normal (Gaussian)</strong> — symmetric noise; the baseline for standard signal processing.</li>
<li><strong>Log-normal</strong> — right-skewed; representative of real-world river flows where flows cannot be negative but can have high outliers.</li>
<li><strong>Weibull</strong> — simulates regimes driven by extreme events or “fat tails.”</li>
</ul>
</section>
</section>
<section id="metric-definitions-provided-by-the-authors" class="level2">
<h2 class="anchored" data-anchor-id="metric-definitions-provided-by-the-authors">Metric definitions provided by the authors</h2>
<ul>
<li><strong>Overlap</strong> — the area shared by the baseline and impacted distributions. An overlap of 1.0 indicates the impact is indistinguishable from natural variability.</li>
<li><strong>Stress score</strong> — calculated as <span class="math inline">\(1 - \text{Overlap}\)</span> (signed by direction of change). A score of <span class="math inline">\(\pm 1.0\)</span> is taken to indicate that the altered flow regime is entirely novel — a “new normal” completely outside the historical range.</li>
</ul>
<p>However, if a change in window length can move the stress score from -0.2 to -1.0 for a relatively small constant change, does -1.0 always reflect a “new regime”?</p>
</section>
<section id="what-the-lower-chart-shows." class="level2">
<h2 class="anchored" data-anchor-id="what-the-lower-chart-shows.">What the lower chart shows.</h2>
<p>The lower panel displays kernel density estimates of the rolling-window mean annual flow values computed from the simulated monthly time series after aggregation to annual means. For a selected window length (e.g., 5, 10, 20, or 30 years), the model first converts monthly flows to one mean value per year, then calculates a moving average across that many years, producing one windowed value per year once the window is full. The density curves therefore approximate the probability distribution of the rolling-window mean annual-flow metric across the full simulated record. Each curve integrates to one. The shaded overlap area represents the shared probability mass between the baseline and post-withdrawal distributions of that rolling mean annual statistic. Because adjacent rolling windows share most of the same years, the values contributing to the density are serially dependent; the chart represents the marginal distribution of the windowed annual-flow metric, not a set of independent multi-year samples.</p>
</section>
<section id="references" class="level2">
<h2 class="anchored" data-anchor-id="references">References</h2>
<ul>
<li><a href="https://doi.org/10.1007/s10584-019-02497-4">Nathan, R.J. et al. (2019). Assessing the degree of hydrologic stress due to climate change. <em>Climatic Change</em>, 156(1–2):87–104.</a></li>
<li><a href="https://doi.org/10.1016/j.jhydrol.2023.129371">John, A. et al. (2023). The time of emergence of climate-induced hydrologic change in Australian rivers. <em>Journal of Hydrology</em>, 619:129371.</a></li>
<li><a href="https://doi.org/10.1016/j.jhydrol.2025.133583">Morden, R. et al. (2025). Mitigating impacts of climate change on flow regimes through management of small dams and abstractions. <em>Journal of Hydrology</em>, 661:133583.</a></li>
</ul>
</section>
</section>
</main>
<!-- /main column -->
<script id="quarto-html-after-body" type="application/javascript">
window.document.addEventListener("DOMContentLoaded", function (event) {
const icon = "";
const anchorJS = new window.AnchorJS();
anchorJS.options = {
placement: 'right',
icon: icon
};
anchorJS.add('.anchored');
const isCodeAnnotation = (el) => {
for (const clz of el.classList) {
if (clz.startsWith('code-annotation-')) {
return true;
}
}
return false;
}
const onCopySuccess = function(e) {
// button target
const button = e.trigger;
// don't keep focus
button.blur();
// flash "checked"
button.classList.add('code-copy-button-checked');
var currentTitle = button.getAttribute("title");
button.setAttribute("title", "Copied!");
let tooltip;
if (window.bootstrap) {
button.setAttribute("data-bs-toggle", "tooltip");
button.setAttribute("data-bs-placement", "left");
button.setAttribute("data-bs-title", "Copied!");
tooltip = new bootstrap.Tooltip(button,
{ trigger: "manual",
customClass: "code-copy-button-tooltip",
offset: [0, -8]});
tooltip.show();
}
setTimeout(function() {
if (tooltip) {
tooltip.hide();
button.removeAttribute("data-bs-title");
button.removeAttribute("data-bs-toggle");
button.removeAttribute("data-bs-placement");
}
button.setAttribute("title", currentTitle);
button.classList.remove('code-copy-button-checked');
}, 1000);
// clear code selection
e.clearSelection();
}
const getTextToCopy = function(trigger) {
const codeEl = trigger.previousElementSibling.cloneNode(true);
for (const childEl of codeEl.children) {
if (isCodeAnnotation(childEl)) {
childEl.remove();
}
}
return codeEl.innerText;
}
const clipboard = new window.ClipboardJS('.code-copy-button:not([data-in-quarto-modal])', {
text: getTextToCopy
});
clipboard.on('success', onCopySuccess);
if (window.document.getElementById('quarto-embedded-source-code-modal')) {
const clipboardModal = new window.ClipboardJS('.code-copy-button[data-in-quarto-modal]', {
text: getTextToCopy,
container: window.document.getElementById('quarto-embedded-source-code-modal')
});
clipboardModal.on('success', onCopySuccess);
}
var localhostRegex = new RegExp(/^(?:http|https):\/\/localhost\:?[0-9]*\//);
var mailtoRegex = new RegExp(/^mailto:/);
var filterRegex = new RegExp('/' + window.location.host + '/');
var isInternal = (href) => {
return filterRegex.test(href) || localhostRegex.test(href) || mailtoRegex.test(href);
}
// Inspect non-navigation links and adorn them if external
var links = window.document.querySelectorAll('a[href]:not(.nav-link):not(.navbar-brand):not(.toc-action):not(.sidebar-link):not(.sidebar-item-toggle):not(.pagination-link):not(.no-external):not([aria-hidden]):not(.dropdown-item):not(.quarto-navigation-tool):not(.about-link)');
for (var i=0; i<links.length; i++) {
const link = links[i];
if (!isInternal(link.href)) {
// undo the damage that might have been done by quarto-nav.js in the case of
// links that we want to consider external
if (link.dataset.originalHref !== undefined) {
link.href = link.dataset.originalHref;
}
}
}
function tippyHover(el, contentFn, onTriggerFn, onUntriggerFn) {
const config = {
allowHTML: true,
maxWidth: 500,
delay: 100,
arrow: false,
appendTo: function(el) {
return el.parentElement;
},
interactive: true,
interactiveBorder: 10,
theme: 'quarto',
placement: 'bottom-start',
};
if (contentFn) {
config.content = contentFn;
}
if (onTriggerFn) {
config.onTrigger = onTriggerFn;
}
if (onUntriggerFn) {
config.onUntrigger = onUntriggerFn;
}
window.tippy(el, config);
}
const noterefs = window.document.querySelectorAll('a[role="doc-noteref"]');
for (var i=0; i<noterefs.length; i++) {
const ref = noterefs[i];
tippyHover(ref, function() {
// use id or data attribute instead here
let href = ref.getAttribute('data-footnote-href') || ref.getAttribute('href');
try { href = new URL(href).hash; } catch {}
const id = href.replace(/^#\/?/, "");
const note = window.document.getElementById(id);
if (note) {
return note.innerHTML;
} else {
return "";
}
});
}
const xrefs = window.document.querySelectorAll('a.quarto-xref');
const processXRef = (id, note) => {
// Strip column container classes
const stripColumnClz = (el) => {
el.classList.remove("page-full", "page-columns");
if (el.children) {
for (const child of el.children) {
stripColumnClz(child);
}
}
}
stripColumnClz(note)
if (id === null || id.startsWith('sec-')) {
// Special case sections, only their first couple elements
const container = document.createElement("div");
if (note.children && note.children.length > 2) {
container.appendChild(note.children[0].cloneNode(true));
for (let i = 1; i < note.children.length; i++) {
const child = note.children[i];
if (child.tagName === "P" && child.innerText === "") {
continue;
} else {
container.appendChild(child.cloneNode(true));
break;
}
}
if (window.Quarto?.typesetMath) {
window.Quarto.typesetMath(container);
}
return container.innerHTML
} else {
if (window.Quarto?.typesetMath) {
window.Quarto.typesetMath(note);
}
return note.innerHTML;
}
} else {
// Remove any anchor links if they are present
const anchorLink = note.querySelector('a.anchorjs-link');
if (anchorLink) {
anchorLink.remove();
}
if (window.Quarto?.typesetMath) {
window.Quarto.typesetMath(note);
}
if (note.classList.contains("callout")) {
return note.outerHTML;
} else {
return note.innerHTML;
}
}
}
for (var i=0; i<xrefs.length; i++) {
const xref = xrefs[i];
tippyHover(xref, undefined, function(instance) {
instance.disable();
let url = xref.getAttribute('href');
let hash = undefined;
if (url.startsWith('#')) {
hash = url;
} else {
try { hash = new URL(url).hash; } catch {}
}
if (hash) {
const id = hash.replace(/^#\/?/, "");
const note = window.document.getElementById(id);
if (note !== null) {
try {
const html = processXRef(id, note.cloneNode(true));
instance.setContent(html);
} finally {
instance.enable();
instance.show();
}
} else {
// See if we can fetch this
fetch(url.split('#')[0])
.then(res => res.text())
.then(html => {
const parser = new DOMParser();
const htmlDoc = parser.parseFromString(html, "text/html");
const note = htmlDoc.getElementById(id);
if (note !== null) {
const html = processXRef(id, note);
instance.setContent(html);
}
}).finally(() => {
instance.enable();
instance.show();
});
}
} else {
// See if we can fetch a full url (with no hash to target)
// This is a special case and we should probably do some content thinning / targeting
fetch(url)
.then(res => res.text())
.then(html => {
const parser = new DOMParser();
const htmlDoc = parser.parseFromString(html, "text/html");
const note = htmlDoc.querySelector('main.content');
if (note !== null) {
// This should only happen for chapter cross references
// (since there is no id in the URL)
// remove the first header
if (note.children.length > 0 && note.children[0].tagName === "HEADER") {
note.children[0].remove();
}
const html = processXRef(null, note);
instance.setContent(html);
}
}).finally(() => {
instance.enable();
instance.show();
});
}
}, function(instance) {
});
}
let selectedAnnoteEl;
const selectorForAnnotation = ( cell, annotation) => {
let cellAttr = 'data-code-cell="' + cell + '"';
let lineAttr = 'data-code-annotation="' + annotation + '"';
const selector = 'span[' + cellAttr + '][' + lineAttr + ']';
return selector;
}
const selectCodeLines = (annoteEl) => {
const doc = window.document;
const targetCell = annoteEl.getAttribute("data-target-cell");
const targetAnnotation = annoteEl.getAttribute("data-target-annotation");
const annoteSpan = window.document.querySelector(selectorForAnnotation(targetCell, targetAnnotation));
const lines = annoteSpan.getAttribute("data-code-lines").split(",");
const lineIds = lines.map((line) => {
return targetCell + "-" + line;
})
let top = null;
let height = null;
let parent = null;
if (lineIds.length > 0) {
//compute the position of the single el (top and bottom and make a div)
const el = window.document.getElementById(lineIds[0]);
top = el.offsetTop;
height = el.offsetHeight;
parent = el.parentElement.parentElement;
if (lineIds.length > 1) {
const lastEl = window.document.getElementById(lineIds[lineIds.length - 1]);
const bottom = lastEl.offsetTop + lastEl.offsetHeight;
height = bottom - top;
}
if (top !== null && height !== null && parent !== null) {
// cook up a div (if necessary) and position it
let div = window.document.getElementById("code-annotation-line-highlight");
if (div === null) {
div = window.document.createElement("div");
div.setAttribute("id", "code-annotation-line-highlight");
div.style.position = 'absolute';
parent.appendChild(div);
}
div.style.top = top - 2 + "px";
div.style.height = height + 4 + "px";
div.style.left = 0;
let gutterDiv = window.document.getElementById("code-annotation-line-highlight-gutter");
if (gutterDiv === null) {
gutterDiv = window.document.createElement("div");
gutterDiv.setAttribute("id", "code-annotation-line-highlight-gutter");
gutterDiv.style.position = 'absolute';
const codeCell = window.document.getElementById(targetCell);
const gutter = codeCell.querySelector('.code-annotation-gutter');
gutter.appendChild(gutterDiv);
}
gutterDiv.style.top = top - 2 + "px";
gutterDiv.style.height = height + 4 + "px";
}
selectedAnnoteEl = annoteEl;
}
};
const unselectCodeLines = () => {
const elementsIds = ["code-annotation-line-highlight", "code-annotation-line-highlight-gutter"];
elementsIds.forEach((elId) => {
const div = window.document.getElementById(elId);
if (div) {
div.remove();
}
});
selectedAnnoteEl = undefined;
};
// Handle positioning of the toggle
window.addEventListener(
"resize",
throttle(() => {
elRect = undefined;
if (selectedAnnoteEl) {
selectCodeLines(selectedAnnoteEl);
}
}, 10)
);
function throttle(fn, ms) {
let throttle = false;
let timer;
return (...args) => {
if(!throttle) { // first call gets through
fn.apply(this, args);
throttle = true;
} else { // all the others get throttled
if(timer) clearTimeout(timer); // cancel #2
timer = setTimeout(() => {
fn.apply(this, args);
timer = throttle = false;
}, ms);
}
};
}
// Attach click handler to the DT
const annoteDls = window.document.querySelectorAll('dt[data-target-cell]');
for (const annoteDlNode of annoteDls) {
annoteDlNode.addEventListener('click', (event) => {
const clickedEl = event.target;
if (clickedEl !== selectedAnnoteEl) {
unselectCodeLines();
const activeEl = window.document.querySelector('dt[data-target-cell].code-annotation-active');
if (activeEl) {
activeEl.classList.remove('code-annotation-active');
}
selectCodeLines(clickedEl);
clickedEl.classList.add('code-annotation-active');
} else {
// Unselect the line
unselectCodeLines();
clickedEl.classList.remove('code-annotation-active');
}
});
}
const findCites = (el) => {
const parentEl = el.parentElement;
if (parentEl) {
const cites = parentEl.dataset.cites;
if (cites) {
return {
el,
cites: cites.split(' ')
};
} else {
return findCites(el.parentElement)
}
} else {
return undefined;
}
};
var bibliorefs = window.document.querySelectorAll('a[role="doc-biblioref"]');
for (var i=0; i<bibliorefs.length; i++) {
const ref = bibliorefs[i];
const citeInfo = findCites(ref);
if (citeInfo) {
tippyHover(citeInfo.el, function() {
var popup = window.document.createElement('div');
citeInfo.cites.forEach(function(cite) {
var citeDiv = window.document.createElement('div');
citeDiv.classList.add('hanging-indent');
citeDiv.classList.add('csl-entry');
var biblioDiv = window.document.getElementById('ref-' + cite);
if (biblioDiv) {
citeDiv.innerHTML = biblioDiv.innerHTML;
}
popup.appendChild(citeDiv);
});
return popup.innerHTML;
});
}
}
});
</script>
</div> <!-- /content -->
</body></html>