Annotation is the process of manually identifying sounds of interest within an audio clip and labeling them. Annotation is possible within viewSpec()
by setting the arguments interactive=TRUE
and annotate=TRUE
.
function (clip, interactive = FALSE, start.time = 0, units = "seconds",
page.length = 30, annotate = FALSE, anno, channel = "left",
output.dir = getwd(), frq.lim = c(0, 12), spec.col = gray.3(),
page.ovlp = 0.25, player = "play", wl = 512, ovlp = 0, wn = "hanning",
consistent = TRUE, mp3.meta = list(kbps = 128, samp.rate = 44100,
stereo = TRUE), main = NULL, ...)
NULL
As with the default of annotate=FALSE
you set interactive=TRUE
to allow paging, zooming, annotation, and other interactive actions. The annotation argument adds an ‘a’ option to the list on the console.
With annotate=TRUE
the spectrogram viewer essentially splits into two modes. In ‘browse’ mode the navigation options are presented in the console to zoom and page the spectrogram. In ‘annotate’ mode sounds of interest are repeatedly selected and named. To start annotate mode type an a in the console and press Enter. The function will stay in annotate mode until you actively exit by right-clicking twice in the graphics window.
# use the interactive and annotate option
annos <- viewSpec(survey, interactive=TRUE, annotate=TRUE)
Starting a new annotation file.
Reading file...
Enter:
a to annotate,
d to delete annotations,
n(m) for next page,
b(v) for previous page,
p to play,
z to zoom in,
x to zoom out,
s to save page as wave file,
c to change spectrogram parameters,
q to exit
The workflow is as follows:
To load existing annotations, specify a file path to a csv file with the anno
argument.
data(survey)
data(survey_anno)
write.csv(survey_anno, 'annos.csv', row.names=FALSE)
viewSpec(survey, annotate=TRUE, anno='annos.csv')
Reading file...
Enter:
a to annotate,
d to delete annotations,
n(m) for next page,
b(v) for previous page,
p to play,
z to zoom in,
x to zoom out,
s to save page as wave file,
c to change spectrogram parameters,
q to exit
Save annotations with same file name (possibly different output.dir)? (Y/n)
File name for annotations (include '.csv'):
Annotations not saved. BUT they are in 'TMPannotations.csv' until written over.
Values stored by the annotate mode are placed in a data frame:
survey_anno
## start.time end.time min.frq max.frq name
## 1 1.059 2.586 3.6105 6.3526 BTNW
## 2 4.209 7.407 2.5839 9.5447 OVEN
## 3 7.552 10.702 2.6261 9.3338 OVEN
## 4 9.850 11.056 3.8777 6.2542 BTNW
## 5 13.836 15.845 2.8230 6.3948 OVEN
## 6 20.698 23.366 3.0339 9.5166 OVEN
## 7 20.891 22.289 4.0183 6.3104 BTNW
Annotations are valuable for a variety of purposes that includes evaluating your templates, which will be covered elsewhere.