-
Notifications
You must be signed in to change notification settings - Fork 4
/
README.Rmd
571 lines (405 loc) · 25.2 KB
/
README.Rmd
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
---
title: "dynaSpec: dynamic spectrogram visualizations"
output: github_document
editor_options:
chunk_output_type: console
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
out.width = "100%"
)
library(warbleR)
```
<!-- badges: start -->
[![lifecycle](https://img.shields.io/badge/lifecycle-maturing-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html) [![Dependencies](https://tinyverse.netlify.com/badge/dynaSpec)](https://cran.r-project.org/package=dynaSpec) [![Project Status: Active The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![Licence](https://img.shields.io/badge/https://img.shields.io/badge/licence-GPL--2-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html) [![minimal R version](https://img.shields.io/badge/R%3E%3D-`r strsplit(gsub("depends: R \\(|\\)", "", grep("DEPENDS", ignore.case = TRUE, readLines(con = "./DESCRIPTION"), value = TRUE), ignore.case = TRUE), ",")[[1]][1]`-6666ff.svg)](https://cran.r-project.org/)
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/dynaSpec)](https://cran.r-project.org/package=dynaSpec)
[![Total Downloads](https://cranlogs.r-pkg.org/badges/grand-total/dynaSpec)](https://cranlogs.r-pkg.org/badges/grand-total/dynaSpec)
<!-- badges: end -->
<img src="man/figures/dynaSpec_sticker.png" alt="sketchy sticker" align="right" width = "25%" height="25%"/>
A set of tools to generate dynamic spectrogram visualizations in video format. [FFMPEG](https://ffmpeg.org/download.html) must be installed in order for this package to work (check [this link for instructions](https://www.rdocumentation.org/packages/ndtv/versions/0.13.3/topics/install.ffmpeg) and this [link for troubleshooting installation on Windows](https://github.com/maRce10/dynaSpec/issues/3)). The package relies heavily on the packages [seewave](https://CRAN.R-project.org/package=seewave) and [tuneR](https://CRAN.R-project.org/package=tuneR).
Please cite [dynaSpec](https://marce10.github.io/dynaSpec/) as follows:
Araya-Salas, Marcelo & Wilkins, Matthew R.. (2020), *dynaSpec: dynamic spectrogram visualizations in R*. R package version 1.0.0.
Install/load the package from CRAN as follows:
```{r, eval = FALSE}
# From CRAN would be
install.packages("dynaSpec")
#load package
library(dynaSpec)
# and load other dependencies
library(viridis)
library(tuneR)
library(seewave)
```
To install the latest developmental version from [github](https://github.com/) you will need the R package [remotes](https://cran.r-project.org/package=remotes):
```{r, eval = FALSE}
# From github
remotes::install_github("maRce10/dynaSpec")
#load package
library(dynaSpec)
```
Installation of external dependencies can be tricky on operating systems other than Linux. An alternative option is to run the package through [google colab](https://colab.google/). This [colab notebook](https://colab.research.google.com/drive/1t3Wn9OifcZTvxOMVNmz9dF25vnzU3_Fr?usp=sharing) explain how to do that step-by-step.
# Background
This package is a collaboration between [Marcelo Araya-Salas](https://marce10.github.io/) and [Matt Wilkins](https://www.mattwilkinsbio.com/). The goal is to create static and dynamic visualizations of sounds, ready for publication or presentation, *without taking screen shots* of another program. [Marcelo's approach](#marcelos-approach-scrolling-dynamic-spectrograms) (implemented in the scrolling_spectro() function) shows a spectrogram sliding past a fixed point as sounds are played, similar to that utilized in Cornell's Macaulay Library of Sounds. These dynamic spectrograms are produced natively with base graphics. [Matt's approach](#matts-approach-paged-dynamic-spectrograms) creates "paged" spectrograms that are revealed by a sliding highlight box as sounds are played, akin to Adobe Audition's spectral view. This approach is in ggplot2 natively, and requires setting up spec parameters and segmenting sound files with prep_static_ggspectro(), the result of which is processed with paged_spectro() to generate a dynamic spectrogram.
<hr>
# Marcelo's Approach: "Scrolling Dynamic Spectrograms"
<hr>
To run the following examples you will also need to load a few more packages as well as [warbleR](https://cran.r-project.org/package=warbleR) >= 1.1.24. It can be installed as follows:
```{r, eval = FALSE}
# From github
devtools::install_github("maRce10/warbleR")
#load package
library(warbleR)
```
A dynamic spectrogram of a canyon wren song with a viridis color palette:
```{r, eval = FALSE}
data("canyon_wren")
scrolling_spectro(wave = canyon_wren, wl = 300,
t.display = 1.7, pal = viridis,
grid = FALSE, flim = c(1, 9),
width = 1000, height = 500,
res = 120, file.name = "default.mp4")
```
<center>
<iframe allowtransparency="true" style="background: #FFFFFF;" style="border:0px solid lightgrey;" width="100%" height="100%" src="https://www.youtube.com/embed/TOiukDxaNbI" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen>
</iframe>
</center>
Black and white spectrogram:
```{r, eval = FALSE}
scrolling_spectro(wave = canyon_wren, wl = 300,
t.display = 1.7, pal = reverse.gray.colors.1,
grid = FALSE, flim = c(1, 9),
width = 1000, height = 500,
res = 120, file.name = "black_and_white.mp4",
collevels = seq(-100, 0, 5))
```
<center>
<iframe allowtransparency="true" style="background: #FFFFFF;" style="border:0px solid lightgrey;" width="100%" height="100%" src="https://www.youtube.com/embed/5gQjgzijHOs" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen>
</iframe>
</center>
A spectrogram with black background (colbg = "black"):
```{r, eval = FALSE}
scrolling_spectro(wave = canyon_wren, wl = 300,
t.display = 1.7, pal = viridis,
grid = FALSE, flim = c(1, 9),
width = 1000, height = 500, res = 120,
file.name = "black.mp4", colbg = "black")
```
<center>
<iframe allowtransparency="true" style="background: #FFFFFF;" style="border:0px solid lightgrey;" width="100%" height="100%" src="https://www.youtube.com/embed/n_GNDn2VH-U" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen>
</iframe>
</center>
Slow down to 1/2 speed (speed = 0.5) with a oscillogram at the bottom (osc = TRUE):
```{r, eval = FALSE}
scrolling_spectro(wave = canyon_wren, wl = 300,
t.display = 1.7, pal = viridis,
grid = FALSE, flim = c(1, 9),
width = 1000, height = 500, res = 120,
file.name = "slow.mp4", colbg = "black",
speed = 0.5, osc = TRUE,
colwave = "#31688E99")
```
<center>
<iframe allowtransparency="true" style="background: #FFFFFF;" style="border:0px solid lightgrey;" width="100%" height="100%" src="https://www.youtube.com/embed/r25TSKSklLo" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen>
</iframe>
</center>
Long-billed hermit song at 1/5 speed (speed = 0.5), removing axes and looping 3 times (loop = 3:
```{r, eval = FALSE}
data("Phae.long4")
scrolling_spectro(wave = Phae.long4, wl = 300,
t.display = 1.7, ovlp = 90, pal = magma,
grid = FALSE, flim = c(1, 10), width = 1000,
height = 500, res = 120, collevels = seq(-50, 0, 5),
file.name = "no_axis.mp4", colbg = "black",
speed = 0.2, axis.type = "none", loop = 3)
```
<center>
<iframe allowtransparency="true" style="background: #FFFFFF;" style="border:0px solid lightgrey;" width="100%" height="100%" src="https://www.youtube.com/embed/7AAoaZUkA3k" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen>
</iframe>
</center>
Visualizing a northern nightingale wren recording from [xeno-canto](https://www.xeno-canto.org) using a custom color palette:
```{r, eval = FALSE}
ngh_wren <- read_wave("https://www.xeno-canto.org/518334/download")
custom_pal <- colorRampPalette( c("#2d2d86", "#2d2d86", reverse.terrain.colors(10)[5:10]))
scrolling_spectro(wave = ngh_wren, wl = 600,
t.display = 3, ovlp = 95, pal = custom_pal,
grid = FALSE, flim = c(2, 8), width = 700,
height = 250, res = 100, collevels = seq(-40, 0, 5),
file.name = "../nightingale_wren.mp4", colbg = "#2d2d86", lcol = "#FFFFFFE6")
```
<center>
<iframe allowtransparency="true" style="background: #FFFFFF;" style="border:0px solid lightgrey; "width="100%" height="100%" src="https://www.youtube.com/embed/OxvKoPyX-4o" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen>
</iframe>
</center>
Spix's disc-winged bat inquiry call slow down (speed = 0.05):
```{r, eval = FALSE}
data("thyroptera.est")
# extract one call
thy_wav <- attributes(thyroptera.est)$wave.objects[[12]]
# add silence at both "sides""
thy_wav <- pastew(tuneR::silence(duration = 0.05,
samp.rate = [email protected], xunit = "time"),
thy_wav, output = "Wave")
thy_wav <- pastew(thy_wav, tuneR::silence(duration = 0.04,
samp.rate = [email protected], xunit = "time"),
output = "Wave")
scrolling_spectro(wave = thy_wav, wl = 400,
t.display = 0.08, ovlp = 95, pal = inferno,
grid = FALSE, flim = c(12, 37), width = 700,
height = 250, res = 100, collevels = seq(-40, 0, 5),
file.name = "thyroptera_osc.mp4", colbg = "black", lcol = "#FFFFFFE6",
speed = 0.05, fps = 200, buffer = 0, loop = 4, lty = 1,
osc = TRUE, colwave = inferno(10, alpha = 0.9)[3])
```
<center>
<iframe allowtransparency="true" style="background: #FFFFFF;" style="border:0px solid lightgrey;" width="100%" height="100%" src="https://www.youtube.com/embed/mFiYPzOe9Nw" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen>
</iframe>
</center>
### Further customization
The argument 'spectro.call' allows to insert customized spectrogram visualizations. For instance, the following code makes use of the `color_spectro()` function from [warbleR](https://cran.r-project.org/package=warbleR) to highlight vocalizations from male and female house wrens with different colors (after downloading the selection table and sound file from figshare):
```{r, eval = FALSE}
# get house wren male female duet recording
hs_wren <- read_wave("https://ndownloader.figshare.com/files/22722101")
# and extended selection table
st <- read.csv("https://ndownloader.figshare.com/files/22722404")
# create color column
st$colors <- c("green", "yellow")
# highlight selections
color.spectro(wave = hs_wren, wl = 200, ovlp = 95, flim = c(1, 13),
collevels = seq(-55, 0, 5), dB = "B", X = st, col.clm = "colors",
base.col = "black", t.mar = 0.07, f.mar = 0.1, strength = 3,
interactive = NULL, bg.col = "black")
```
<img src="man/figures/colored_spectro_house_wren_duet.png" alt="house wren duet">
The male part is shown in green and the female part in yellow.
We can wrap the `color_spectro()` call using the `call()` function form base R and input that into `scrolling_spectro()` using the argument 'spectro.call':
```{r, eval = FALSE}
# save call
sp_cl <- call("color.spectro", wave = hs_wren, wl = 200, ovlp = 95,
flim = c(1, 13), collevels = seq(-55, 0, 5), strength = 3,
dB = "B", X = st, col.clm = "colors", base.col = "black",
t.mar = 0.07, f.mar = 0.1, interactive = NULL, bg.col = "black")
# create dynamic spectrogram
scrolling_spectro(wave = hs_wren, wl = 512,
t.display = 1.2, pal = reverse.gray.colors.1,
grid = FALSE, flim = c(1, 13), loop = 3,
width = 1000, height = 500, res = 120,
collevels = seq(-100, 0, 1), spectro.call = sp_cl, fps = 60,
file.name = "yellow_and_green.mp4")
```
<center>
<iframe allowtransparency="true" style="background: #FFFFFF;" style="border:0px solid lightgrey;" width="100%" height="100%" src="https://www.youtube.com/embed/9qMPxYuGUJE" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen>
</iframe>
</center>
This option can be mixed with any of the other customizations in the function, as adding an oscillogram:
```{r, eval = FALSE}
# create dynamic spectrogram
scrolling_spectro(wave = hs_wren, wl = 512, osc = TRUE,
t.display = 1.2, pal = reverse.gray.colors.1,
grid = FALSE, flim = c(1, 13), loop = 3,
width = 1000, height = 500, res = 120,
collevels = seq(-100, 0, 1),
spectro.call = sp_cl, fps = 60,
file.name = "yellow_and_green_oscillo.mp4")
```
<center>
<iframe allowtransparency="true" style="background: #FFFFFF;" style="border:0px solid lightgrey;" width="100%" height="100%" src="https://www.youtube.com/embed/k6OumiKsRWw" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen>
</iframe>
</center>
A viridis color palette:
```{r, eval = FALSE}
st$colors <- viridis(10)[c(3, 8)]
sp_cl <- call("color.spectro", wave = hs_wren, wl = 200,
ovlp = 95, flim = c(1, 13), collevels = seq(-55, 0, 5),
dB = "B", X = st, col.clm = "colors",
base.col = "white", t.mar = 0.07, f.mar = 0.1,
strength = 3, interactive = NULL)
# create dynamic spectrogram
scrolling_spectro(wave = hs_wren, wl = 200, osc = TRUE,
t.display = 1.2, pal = reverse.gray.colors.1,
grid = FALSE, flim = c(1, 13), loop = 3,
width = 1000, height = 500, res = 120,
collevels = seq(-100, 0, 1), colwave = viridis(10)[c(9)],
spectro.call = sp_cl, fps = 60,
file.name = "viridis.mp4")
```
<center>
<iframe allowtransparency="true" style="background: #FFFFFF;" style="border:0px solid lightgrey;" width="100%" height="100%" src="https://www.youtube.com/embed/HvV2NFuJeIU" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen>
</iframe>
</center>
Or simply a gray scale:
```{r, eval = FALSE}
st$colors <- c("gray", "gray49")
sp_cl <- call("color.spectro", wave = hs_wren, wl = 200, ovlp = 95, flim = c(1, 13),
collevels = seq(-55, 0, 5), dB = "B", X = st, col.clm = "colors",
base.col = "white", t.mar = 0.07, f.mar = 0.1, strength = 3,
interactive = NULL)
# create dynamic spectrogram
scrolling_spectro(wave = hs_wren, wl = 512, osc = TRUE,
t.display = 1.2, pal = reverse.gray.colors.1,
grid = FALSE, flim = c(1, 13), loop = 3,
width = 1000, height = 500, res = 120,
collevels = seq(-100, 0, 1),
spectro.call = sp_cl, fps = 60,
file.name = "gray.mp4")
```
<center>
<iframe allowtransparency="true" style="background: #FFFFFF;" style="border:0px solid lightgrey;" width="100%" height="100%" src="https://www.youtube.com/embed/gd096zAG5NE" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen>
</iframe>
</center>
The 'spectro.call' argument can also be used to add annotations. To do this we need to wrap up both the spectrogram function and the annotation functions (i.e. `text()`, `lines()`) in a single function and then save the call to that function:
```{r, eval = FALSE}
# create color column
st$colors <- viridis(10)[c(3, 8)]
# create label column
st$labels <- c("male", "female")
# shrink end of second selection (purely aesthetics)
st$end[2] <- 3.87
# function to highlight selections
ann_fun <- function(wave, X){
# print spectrogram
color.spectro(wave = wave, wl = 200,
ovlp = 95, flim = c(1, 18.6), collevels = seq(-55, 0, 5),
dB = "B", X = X, col.clm = "colors",
base.col = "white", t.mar = 0.07, f.mar = 0.1,
strength = 3, interactive = NULL)
# annotate each selection in X
for(e in 1:nrow(X)){
# label
text(x = X$start[e] + ((X$end[e] - X$start[e]) / 2),
y = 16.5, labels = X$labels[e], cex = 3.3,
col = adjustcolor(X$colors[e], 0.6))
# line
lines(x = c(X$start[e], X$end[e]), y = c(14.5, 14.5),
lwd = 6, col = adjustcolor("gray50", 0.3))
}
}
# save call
ann_cl <- call("ann_fun", wave = hs_wren, X = st)
# create annotated dynamic spectrogram
scrolling_spectro(wave = hs_wren, wl = 200, t.display = 1.2,
grid = FALSE, flim = c(1, 18.6), loop = 3,
width = 1000, height = 500, res = 200,
collevels = seq(-100, 0, 1), speed = 0.5,
spectro.call = ann_cl, fps = 120,
file.name = "../viridis_annotated.mp4")
```
<center>
<iframe allowtransparency="true" style="background: #FFFFFF;" style="border:0px solid lightgrey;" width="100%" height="100%" src="https://www.youtube.com/embed/wbpjKfZUUIw" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen>
</iframe>
</center>
Finally, the argument 'annotation.call' can be used to add static labels (i.e. non-scrolling). It works similar to 'spectro.call', but requires a call from `text()`. This let users customize things as size, color, position, font, and additional arguments taken by `text()`. The call should also include the argmuents 'start' and 'end' to indicate the time at which the labels are displayed (in s). 'fading' is optional and allows fade-in and fade-out effects on labels (in s as well). The following code downloads a recording containing several frog species recorded in Costa Rica from figshare, cuts a clip including two species and labels it with a single label:
```{r, eval = FALSE}
# read data from figshare
frogs <- read_wave("https://ndownloader.figshare.com/files/22829075")
# cut a couple of species
shrt_frgs <- cutw(frogs, from = 35.3, to = 50.5, output = "Wave")
# make annotation call
ann_cll <- call("text", x = 0.25, y = 0.87,
labels = "Frog calls", cex = 1, start = 0.2, end = 14,
col = "#FFEA46CC", font = 3, fading = 0.6)
# create dynamic spectro
scrolling_spectro(wave = shrt_frgs, wl = 512, ovlp = 95,
t.display = 1.1, pal = cividis,
grid = FALSE, flim = c(0, 5.5), loop = 3,
width = 1200, height = 550, res = 200,
collevels = seq(-40, 0, 5), lcol = "#FFFFFFCC",
colbg = "black", fps = 60, file.name = "../frogs.mp4",
osc = TRUE, height.prop = c(3, 1), colwave = "#31688E",
lty = 3, annotation.call = ann_cll)
```
<center>
<iframe allowtransparency="true" style="background: #FFFFFF;" style="border:0px solid lightgrey;" width="100%" height="100%" src="https://www.youtube.com/embed/Ux71aMVa_oU" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen>
</iframe>
</center>
The argument accepts more than one labels as in a regular `text()` call. In that case 'start' and 'end' values should be supplied for each label:
```{r, eval = FALSE}
# make annotation call for 2 annotations
ann_cll <- call("text", x = 0.25, y = 0.87,
labels = c("Dendropsophus ebraccatus", "Eleutherodactylus coqui"),
cex = 1, start = c(0.4, 7),
end = c(5.5, 14.8), col = "#FFEA46CC", font = 3, fading = 0.6)
# create dynamic spectro
scrolling_spectro(wave = shrt_frgs, wl = 512, ovlp = 95,
t.display = 1.1, pal = cividis,
grid = FALSE, flim = c(0, 5.5), loop = 3,
width = 1200, height = 550, res = 200,
collevels = seq(-40, 0, 5), lcol = "#FFFFFFCC", colbg = "black",
fps = 60, file.name = "../frogs_sp_labels.mp4", osc = TRUE,
height.prop = c(3, 1),colwave = "#31688E", lty = 3,
annotation.call = ann_cll)
```
<center>
<iframe allowtransparency="true" style="background: #FFFFFF;" style="border:0px solid lightgrey;" width="100%" height="100%" src="https://www.youtube.com/embed/nFfYr8Tc53Q" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen>
</iframe>
</center>
<hr>
# Matt's approach: "Paged Dynamic Spectrograms"
<hr>
### Workflow
1. Tweak your spectrogram settings using the prep_static_ggspectro() function -- aka prepStaticSpec() -- storing results in variable. You can also just segment and export static specs at this step.
2. Feed variable into paged_spectro() -- aka pagedSpec() -- to generate a dynamic spectrogram
* It does this by exporting a PNG of the testSpec() ggplot function;
* Import PNG as a new ggplot raster layer
* Overlay a series of translucent highlight boxes that disolve away using gganimate
```
#list WAVs included with dynaSpec
(f<-system.file(package="dynaSpec") |> list.files(pattern=".wav",full.names=T))
#store output and save spectrogram to working directory
params <-prep_static_ggspectro(f[1],destFolder="wd",savePNG=T)
```
### Static spectrogram of a female barn swallow song
![Static Spectrogram of a female barn swallow song](man/figures/femaleBarnSwallow_1.png)
```{r, eval = FALSE}
#let's add axes
femaleBarnSwallow<-prep_static_ggspectro(f[1],destFolder=tempdir(),savePNG=T,onlyPlotSpec = F)
```
![Static spectrogram with axis labels for female barn swallow song](man/figures/femaleBarnSwallow_1b.png)
```{r, eval = FALSE}
#Now generate a dynamic spectrogram
paged_spectro(femaleBarnSwallow)
```
### Dynamic spectrogram of a female barn swallow song
<iframe src="https://player.vimeo.com/video/432706727" style="border:0px" width="100%" height="100%" frameborder="0" allow="autoplay; fullscreen" allowfullscreen></iframe>
### Now brighten the spec using the ampTrans parameter
* ampTrans=3 is a nonlinear signal booster. Basically collapses the difference between loudest and quietest values (higher values= brighter specs); 1 (default) means no transformation
* Here, I also lowered the decibel threshold to include some quieter sounds with min_dB=-35; default is -30
* bgFlood=T makes the axis area the same color as the plot background. It will automatically switch to white axis font if background is too dark.
* Then generate dynamic spectrogram
```{r, eval = FALSE}
#note that prep_static_spectro() is tha same as prepStaticSpec()
#Also paged_spectro() is the same as pagedSpec()
p2<-prepStaticSpec(f[1],min_dB=-35, savePNG=T, destFolder="wd",onlyPlotSpec=F,bgFlood=T,ampTrans=3)
pagedSpec(p2)
```
![Static spectrogram with axis labels for female barn swallow song](man/figures/femaleBarnSwallow_1c.png)
<iframe src="https://player.vimeo.com/video/432727824" style="border:0px" width="100%" height="100%" frameborder="0" allow="autoplay; fullscreen" allowfullscreen></iframe>
### Now also supports .mp3 files (web or local) and multi-page dynamic spectrograms (i.e. cropping and segmenting spectrograms from larger recording files)
* Long files may take a long time to render, depending on CPU power...
* the default is to not plot axes and labels (onlyPlotSpec=T)
* crop=12 is interpreted as: only use the first 12 seconds of the file; can also specify interval w/ c(0,12)
* xLim=3 specifies the "page window" i.e. how many seconds each "page" of the dynamic spectrogram should display, here 3 sec
* here we also limit the yLim of the plot to the vocalized frequencies from 0 to 700 Hz (0.7 kHz)
```{r, eval = FALSE}
whale<-prepStaticSpec("http://www.oceanmammalinst.org/songs/hmpback3.wav",
savePNG=T,destFolder="wd",yLim=c(0,.7),crop=12,xLim=3,ampTrans=3)
pagedSpec(whale)
#Voila 🐋
```
### Static whale song spectrogram
![Humpback whale song spectrogram](man/figures/humpback.png)
### Dynamic multipage whale song spectrogram
<iframe src="https://player.vimeo.com/video/432723336" style="border:0px" frameborder="0" width="100%" height="100%" allow="autoplay; fullscreen" allowfullscreen></iframe>
### Example using Xeno-Canto to generate a multi-page dynamic spectrogram of a common nighthawk call (w/ different color scheme)
```{r, eval = FALSE}
song="https://www.xeno-canto.org/sounds/uploaded/SPMWIWZKKC/XC490771-190804_1428_CONI.mp3"
temp=prepStaticSpec(song,crop=20,xLim=4,colPal = c("white","black"))
pagedSpec(temp,vidName="nightHawk" ,highlightCol = "#d1b0ff",cursorCol = "#7817ff")
```
### Nighthawk multipage dynamic spec
<iframe src="https://player.vimeo.com/video/432724657" style="border:0px; width: 100%;" width="100%" height="100%" margin="0" padding="0" frameborder="0" allow="autoplay; fullscreen" allowfullscreen></iframe>
Enjoy! Please share your specs with us on Twitter! [\@M_Araya_Salas](https://twitter.com/M_Araya_Salas) & [\@mattwilkinsbio](https://twitter.com/mattwilkinsbio)
------------------------------------------------------------------------
Please cite [dynaSpec](https://marce10.github.io/dynaSpec/) as follows:
Araya-Salas, Marcelo and Wilkins, Matthew R. (2020), *dynaSpec: dynamic spectrogram visualizations in R*. R package version 1.0.0.