Introduccion a warbleR

Cuadros de selección extendidos

Cuando el argumento extended = TRUE la función genera un objeto de la clase extended_selection_table que también contiene una lista de objetos ‘wave’ correspondientes a cada una de las selecciones en el cuadro de datos. Por lo tanto, la función transforma las cuadros de selección en objetos autocontenidos ya que ya no necesitan los archivos de sonido originales para ejecutar la mayoría del análisis acústico en warbleR. Esto puede facilitar mucho el almacenamiento y el intercambio de datos (bio) acústicos. Además, también acelera los procesos, ya que no es necesario leer los archivos de sonido cada vez que se analizan los datos.

Ahora, como se mencionó anteriormente, necesita la función selection_table(() para crear un cuadro de selección extendido. También debe establecer el argumento extended = TRUE (de lo contrario, la clase sería un cuadro de selección). El siguiente código convierte los datos de ejemplo en un cuadro de selección extendido:

# parametros globales
warbleR_options(wav.path = "PONER RUTA A 'ejemplos' AQUI")


ext_st <- selection_table(X = lbh_selec_table, pb = FALSE, 
          extended = TRUE, confirm.extended = FALSE)

all selections are OK 

Y eso es. Ahora los datos acústicos y los datos de selección (así como los metadatos adicionales) están todos juntos en un solo objeto R.

& nbsp;

Manipulación de cuadros de selección extendidos

Se pueden usar varias funciones para tratar con objetos de esta clase. Puede probar si el objeto pertenece a la extended_selection_table:

is_extended_selection_table(ext_st)

[1] TRUE

Puede subcontratar la selección de la misma manera que cualquier otro cuadro de datos en ella mantendrá sus atributos:

ext_st2 <- ext_st[1:2, ]

is_extended_selection_table(ext_st2)

[1] TRUE

También hay una versión genérica de print() para esta clase de objetos:

## print
print(ext_st)

object of class 'extended_selection_table' 
 contains a selection table data frame with 11 rows and 9 columns: 
       sound.files channel selec start       end bottom.freq top.freq sel.comment rec.comment
1 Phae.long1.wav_1       1     1   0.1 0.2730334    2.220105 8.604378         c24          NA
2 Phae.long1.wav_2       1     1   0.1 0.2630480    2.169437 8.807053         c25          NA
3 Phae.long1.wav_3       1     1   0.1 0.2749187    2.218294 8.756604         c26          NA
4 Phae.long2.wav_1       1     1   0.1 0.2325709    2.316862 8.822316         c27          NA
5 Phae.long2.wav_2       1     1   0.1 0.2261502    2.284006 8.888027         c28          NA
6 Phae.long3.wav_1       1     1   0.1 0.2312195    3.006834 8.822316         c29          NA
... and 5 more rows 
11 wave objects (as attributes): 
[1] "Phae.long1.wav_1" "Phae.long1.wav_2" "Phae.long1.wav_3" "Phae.long2.wav_1" "Phae.long2.wav_2"
[6] "Phae.long3.wav_1"
... and 5 more 
and a data frame (check.results) generated by checkres() (as attribute) 
the selection table was created by element (see 'class_extended_selection_table')

… lo cual es equivalente a:

ext_st

object of class 'extended_selection_table' 
 contains a selection table data frame with 11 rows and 9 columns: 
       sound.files channel selec start       end bottom.freq top.freq sel.comment rec.comment
1 Phae.long1.wav_1       1     1   0.1 0.2730334    2.220105 8.604378         c24          NA
2 Phae.long1.wav_2       1     1   0.1 0.2630480    2.169437 8.807053         c25          NA
3 Phae.long1.wav_3       1     1   0.1 0.2749187    2.218294 8.756604         c26          NA
4 Phae.long2.wav_1       1     1   0.1 0.2325709    2.316862 8.822316         c27          NA
5 Phae.long2.wav_2       1     1   0.1 0.2261502    2.284006 8.888027         c28          NA
6 Phae.long3.wav_1       1     1   0.1 0.2312195    3.006834 8.822316         c29          NA
... and 5 more rows 
11 wave objects (as attributes): 
[1] "Phae.long1.wav_1" "Phae.long1.wav_2" "Phae.long1.wav_3" "Phae.long2.wav_1" "Phae.long2.wav_2"
[6] "Phae.long3.wav_1"
... and 5 more 
and a data frame (check.results) generated by checkres() (as attribute) 
the selection table was created by element (see 'class_extended_selection_table')

También puedes unirlos en filas. Aquí el extended_selection_table original se divide en 2 y se enlaza nuevamente usando rbind():

ext_st3 <- ext_st[1:5, ]

ext_st4 <- ext_st[6:11, ]

ext_st5 <- rbind(ext_st3, ext_st4)

#print
ext_st5

object of class 'extended_selection_table' 
 contains a selection table data frame with 11 rows and 9 columns: 
       sound.files channel selec start       end bottom.freq top.freq sel.comment rec.comment
1 Phae.long1.wav_1       1     1   0.1 0.2730334    2.220105 8.604378         c24          NA
2 Phae.long1.wav_2       1     1   0.1 0.2630480    2.169437 8.807053         c25          NA
3 Phae.long1.wav_3       1     1   0.1 0.2749187    2.218294 8.756604         c26          NA
4 Phae.long2.wav_1       1     1   0.1 0.2325709    2.316862 8.822316         c27          NA
5 Phae.long2.wav_2       1     1   0.1 0.2261502    2.284006 8.888027         c28          NA
6 Phae.long3.wav_1       1     1   0.1 0.2312195    3.006834 8.822316         c29          NA
... and 5 more rows 
11 wave objects (as attributes): 
[1] "Phae.long1.wav_1" "Phae.long1.wav_2" "Phae.long1.wav_3" "Phae.long2.wav_1" "Phae.long2.wav_2"
[6] "Phae.long3.wav_1"
... and 5 more 
and a data frame (check.results) generated by checkres() (as attribute) 
the selection table was created by element (see 'class_extended_selection_table')

# igual q el original
all.equal(ext_st, ext_st5)

[1] TRUE

Los objetos ‘wave’ se pueden leer individualmente usando read_wave(), un contenedor en la función readWave() de tuneR, que puede tomar cuadros de selección extendidos:

wv1 <- read_wave(X = ext_st, index = 3, from = 0, to = 0.37)

Estos son objetos ‘wave’ regulares:

class(wv1)

[1] "Wave"
attr(,"package")
[1] "tuneR"

wv1

Wave Object
    Number of Samples:      8325
    Duration (seconds):     0.37
    Samplingrate (Hertz):   22500
    Channels (Mono/Stereo): Mono
    PCM (integer format):   TRUE
    Bit (8/16/24/32/64):    16 

spectro(wv1, wl = 150, grid = FALSE, scale = FALSE, ovlp = 90)

par(mfrow = c(3, 2), mar = rep(0, 4))

for(i in 1:6){
  
  wv <- read_wave(X = ext_st, index = i, from = 0.05, to = 0.32)

  spectro(wv, wl = 150, grid = FALSE, scale = FALSE, axisX = FALSE,
          axisY = FALSE, ovlp = 90)

}

La función read_wave() require el cuadro de selección, así como el índice de la selección (por ejemplo, el número de fila) para poder leer los objetos ‘wave’.

Tenga en cuenta que es probable que otras funciones que modifican marcos de datos eliminen los atributos en los que se almacenan los objetos ‘wave’ y los metadatos. Por ejemplo, la fusión y el cuadro de selección extendido eliminarán sus atributos:

# crear nueva base de datos
Y <- data.frame(sound.files = ext_st$sound.files, site = "La Selva", lek = c(rep("SUR", 5), rep("CCL", 6)))

# combinar
mrg_ext_st <- merge(ext_st, Y, by = "sound.files")

# revisar clase
is_extended_selection_table(mrg_ext_st)

[1] FALSE

En este caso, podemos utilizar la función fix_extended_selection_table () para transferir los atributos del cuadro de selección extendido original:

# arreglar
mrg_ext_st <- fix_extended_selection_table(X = mrg_ext_st, Y = ext_st)

# revisar clase
is_extended_selection_table(mrg_ext_st)

[1] TRUE

Esto funciona siempre que se conserven algunos de los archivos de sonido originales y no se agreguen otras selecciones.

& nbsp;

Tamaño del cuadro de selección

El tamaño del cuadro de selección extendido dependerá del número de selecciones, la tasa de muestreo, la duración de la selección y la duración del margen (el margen es la cantidad de tiempo adicional que desea conservar a cada lado de la selección). En este ejemplo, se crea un cuadro de datos con 1000 selecciones simplemente repitiendo el cuadro de datos de ejemplo varias veces y luego se convierte en un cuadro de selección extendido:

lng.selec.table <- do.call(rbind, replicate(100, lbh_selec_table, 
                        simplify = FALSE))[1:1000,]

lng.selec.table$selec <- 1:nrow(lng.selec.table)

nrow(lng.selec.table)

lng_ext_st <- selection_table(X = lng.selec.table, pb = FALSE, 
                        extended = TRUE, confirm.extended = FALSE)

lng_ext_st

all selections are OK 

object of class 'extended_selection_table' 
 contains a selection table data frame with 1000 rows and 9 columns: 
       sound.files channel selec start       end bottom.freq top.freq sel.comment rec.comment
1 Phae.long1.wav_1       1     1   0.1 0.2730334    2.220105 8.604378         c24          NA
2 Phae.long1.wav_2       1     1   0.1 0.2630480    2.169437 8.807053         c25          NA
3 Phae.long1.wav_3       1     1   0.1 0.2749187    2.218294 8.756604         c26          NA
4 Phae.long2.wav_4       1     1   0.1 0.2325709    2.316862 8.822316         c27          NA
5 Phae.long2.wav_5       1     1   0.1 0.2261502    2.284006 8.888027         c28          NA
6 Phae.long3.wav_6       1     1   0.1 0.2312195    3.006834 8.822316         c29          NA
... and 994 more rows 
1000 wave objects (as attributes): 
[1] "Phae.long1.wav_1" "Phae.long1.wav_2" "Phae.long1.wav_3" "Phae.long2.wav_4" "Phae.long2.wav_5"
[6] "Phae.long3.wav_6"
... and 994 more 
and a data frame (check.results) generated by checkres() (as attribute) 
the selection table was created by element (see 'class_extended_selection_table')

format(object.size(lng_ext_st), units = "auto")

[1] "31.4 Mb"

Como se puede ver, el tamaño del objeto es de solo ~ 31 MB. Entonces, como guía, un cuadro de selección con 1000 selecciones similares a las de ‘lbh_selec_table’ (duración media de ~ 0.15 segundos) a una tasa de muestreo de 22.5 kHz y el margen predeterminado (mar = 0.1) generará un cuadro de selección extendido de ~ 31 MB o ~ 310 MB para un cuadro de selección de 10000 filas.

Análisis usando cuadros de selección extendidos

Estos objetos se pueden usar como entrada para la mayoría de las funciones warbleR. Aquí hay algunos ejemplos de funciones de warbleR usando extended_selection_table:

#  parametros espectrales
sp <- specan(ext_st)

sp

snr <- sig2noise(ext_st, mar = 0.05)

snr

dtw.dist <- dfDTW(ext_st, img = FALSE)

dtw.dist

measuring dominant frequency contours (step 1 of 2):
measuring dominant frequency:calculating DTW distances (step 2 of 2, no progress bar):

Desempeño

El uso de objetos extended_selection_table puede mejorar el rendimiento (en nuestro caso, medido como tiempo). Aquí usamos microbenchmark para comparar el rendimiento de sig2noise() y ggplot2 para trazar los resultados:

# cragar paquetes
library(microbenchmark)
library(ggplot2)

# usar las primeras 100 selecciones
mbmrk.snr <- microbenchmark(extended = sig2noise(lng_ext_st[1:100, ], 
      mar = 0.05), regular = sig2noise(lng.selec.table[1:100, ], 
                    mar = 0.05), times = 50)

autoplot(mbmrk.snr) + ggtitle("sig2noise")

Coordinate system already present. Adding new coordinate system, which will replace the existing one.

La función se ejecuta mucho más rápido en los cuadros de selección extendidos. Es probable que la ganancia en el rendimiento mejore cuando se utilizan grabaciones y conjuntos de datos más largos (es decir, compensar la sobrecarga informática).

Crear selecciones ‘por canto’

Los de selección ampliadas de arriba fueron hechas por elemento (by.element). Esto es, cada archivo de sonido dentro del objeto contiene una sola selección (es decir, una correspondencia 1: 1 entre las selecciones y los objetos ‘wave’). Sin embargo, los cuadros de selección extendidos también se pueden crear utilizando un nivel jerárquico superior con el argumento by.song. En este caso, “canción” representa un nivel superior que contiene una o más selecciones y que el usuario puede querer mantener juntos para algún análisis en particular (por ejemplo, la duración de los intervalos). El argumento by.song toma el nombre de la columna de caracteres o factores con los ID de las diferentes “cantos” dentro de un archivo de sonido (tenga en cuenta que la función supone que un canto determinado solo se puede encontrar en un solo archivo de sonido, por lo que las selecciones con el mismo ID de canto, pero de diferentes archivos de sonido se toma como ‘cantos’ diferentes).

Para crear un cuadro de selección por canto, agreguemos una columna de canto artificial a nuestros datos de ejemplo en el que cada uno de los archivos de sonido tiene 2 cantos:

# add column
lbh_selec_table$song <- c(1, 1, 2, 1, 2, 1, 1, 2, 1, 2, 2)

El cuadro de datos se ve así:

Ahora podemos crear un cuadro de selección extendido ‘por canto’ usando el nombre de la columna ‘canto’ (que en este ejemplo simple también es ‘canto’) como entrada para el argumento by.song:

bs_ext_st <- selection_table(X = lbh_selec_table, extended = TRUE,
                              confirm.extended = FALSE, by.song = "song")

checking selections (step 1 of 2):
all selections are OK 
saving wave objects into extended selection table (step 2 of 2):

En este caso, solo deberíamos tener 8 objetos ‘wave’ en lugar de 11 como cuando el objeto fue creado ‘por selección’:

# by element
length(attr(ext_st, "wave.objects"))

[1] 11

# by song
length(attr(bs_ext_st, "wave.objects"))

[1] 8

Nuevamente, estos objetos también pueden usarse en los análisis:

# proporcion señal ruido
bs_snr <- sig2noise(bs_ext_st, mar = 0.05)

Compartir datos acústicos

La nueva clase de objetos permite compartir conjuntos de datos completos, incluidos los datos acústicos. Por ejemplo, con el siguiente código puede descargar un subconjunto de los datos utilizados en Araya-Salas et al (2017) (también se puede descargar aquí):

URL <- "https://marceloarayasalas.weebly.com/uploads/2/5/5/2/25524573/extended.selection.table.araya-salas.et.al.2017.bioacoustics.100.sels.rds"

dat <- readRDS(gzcon(url(URL)))

nrow(dat)

[1] 100

format(object.size(dat), units = "auto")

[1] "10.1 Mb"

El tamaño total de los 100 archivos de sonido de los que se tomaron estas selecciones suma hasta 1.1 GB. El tamaño del cuadro de selección extendido es de solo 10.1 MB.

Estos datos están listos para ser utilizados:

sp <- specan(dat, bp = c(2, 10))

head(sp)

Y los espectrogramas se pueden visualizar:

par(mfrow = c(3, 2), mar = rep(0, 4))

for(i in 1:6){
  
  wv <- read_wave(X = dat, index = i, from = 0.17, to = 0.4)

  spectro(wv, wl = 250, grid = FALSE, scale = FALSE, axisX = FALSE,
          axisY = FALSE, ovlp = 90, flim = c(0, 12), 
          palette = reverse.gray.colors.1)
}

el paquete NatureSounds contiene un cuadro de selección extendido con cantos de Phaethornis longirotris de 10 tipos de canto diferentes:

data("Phae.long.est")

Phae.long.est

object of class 'extended_selection_table' 
 contains a selection table data frame with 100 rows and 8 columns: 
                    sound.files selec start     end bottom.freq top.freq lek lek.song.type
31 0.BR1.2012.7.27.5.55.wav_3-4     1   0.1 0.25771      2.3227   11.673 BR1        BR1-D1
32   0.BR1.2012.7.27.5.55.wav_1     1   0.1 0.25480      2.3680   11.718 BR1        BR1-D1
33 0.BR1.2012.7.27.5.55.wav_3-3     1   0.1 0.25556      2.5492   11.900 BR1        BR1-D1
34   0.BR1.2012.7.27.5.55.wav_4     1   0.1 0.26021      2.6398   11.990 BR1        BR1-D1
35 0.BR1.2012.7.27.5.55.wav_2-2     1   0.1 0.26156      2.2774   11.628 BR1        BR1-D1
36   0.BR1.2012.7.27.5.55.wav_3     1   0.1 0.25803      2.6398   11.990 BR1        BR1-D1
... and 94 more rows 
100 wave objects (as attributes): 
[1] "0.BR1.2012.7.27.5.55.wav_3-4" "0.BR1.2012.7.27.5.55.wav_1"   "0.BR1.2012.7.27.5.55.wav_3-3"
[4] "0.BR1.2012.7.27.5.55.wav_4"   "0.BR1.2012.7.27.5.55.wav_2-2" "0.BR1.2012.7.27.5.55.wav_3"  
... and 94 more 
and a data frame (check.results) generated by checkres() (as attribute) 
the selection table was created by element (see 'class_extended_selection_table')

table(Phae.long.est$lek.song.type)

BR1-D1 CCL-G1 CCL-K2 DAR-A1 HC2-E1 HC2-F2 SAT-G2 SJA-C3 SUR-E4 TR1-E1 
    10     10     10     10     10     10     10     10     10     10 

La capacidad de comprimir grandes conjuntos de datos y la facilidad de realizar análisis que requieren un único objeto R puede simplificar el intercambio de datos y la reproducibilidad de los análisis bioacústicos.

Obtener y preparar grabaciones

La función querxc() permite hacer busquedas y descargar sonidos de la base de datos de acceso libre Xeno-Canto. Además se pueden convertir archivos .mp3 a .wav, cambiar la tasa de muestreo de los archivos y corregir archivos corruptos, entre otras funciones.

Anotar

Se recomienda hacer anotaciones en otros programas e importarlas luego a R (por ejemplo en Raven e importarlas con el paquete Rraven). Sin embargo, warbleR ofrece algunas funciones para facilitar la anotación manual o automática de archivos de sonido, asi como la posterior manipulación:

Organizar anotaciones

Las anotaciones (o cuadros de selección) pueden ser manipulados y refinados con una variedad de funciones. Los cuadros de selección también sepueden convertir en el formato compacto de cuadros extendidos:

Medir la estructura de señales acústicas

La mayoría de las funciones de warbleR están dedicadas a ćuantificar la estructura de señales acústicas enlistadas en cuadros de seleccion utilizando procesamiento en lotes (“batch processing”). Para esto se ofrecen 5 métodos principales de medición:

1. Parametros espectrográficos
2. Correlación cruzada
3. Distorsión dinámica de tiempo (DTW)
4. Descriptores estadísticos de los coeficientes cepstrales

La mayoria de fuciones giran alrededor de estos métodos, o variaciones de estos:

Verificar anotaciones

Se proveen funciones para detectar inconsistencias en los cuadros de selección o modificar cuadros de selección. El paquete también ofrece varias funciones para generar espectrogramas mostrando las anotaciones, o organizar que son organizados por las categorías de anotación. Esto permite verificar si las anotaciones coinciden con las categorias previamente definidas. Esto es particularmente importante si las anotaciones fueron generas automáticamente.

Inspeccionar visualmente anotaciones y mediciones

Funciones adicionales

Por último, warbleR ofrece funciones para simplificar el uso de cuadros de selección extendidos, para organizar gran cantidad de imagenes con espectrogramas y generar visualizaciones complejas con espectrogramas: