divime_classify_vox: run the DiViMe vocalization classification module 'vcm'

Description Usage Arguments Details Value

View source: R/divime_classify_vox.R

Description

run the DiViMe vocalization classification module vcm

Usage

1
2
3
divime_classify_vox(audio_loc, divime_loc, marvinator = TRUE,
  vmstart = TRUE, vmshutdown = TRUE, messages = TRUE,
  overwrite = FALSE)

Arguments

audio_loc

character, path to the audio files

divime_loc

character, path to the DiViMe directory with running VM

marvinator

logical, look for Marvin's version of yunitator results, by default TRUE

vmstart

logical, perform a check whether the VM is running and if not start it up (by default TRUE). Turning this off, will speed up the function a little bit, but requires that you are sure that the VM is indeed running in divime_loc.

vmshutdown

logical, should the VM be shut down after the operations are done (by default TRUE)

messages

logical, should the file names of each processed file be printed

overwrite

logical, should output files be overwritten if they already exist (default is FALSE)

Details

The marvinator= argument determines which kind of yunitator file is looked for. If TRUE the file looked for is 'yunitator_english_X.rttm', where X is the name of the underlying audio file (which is the result of divime_talkertype(..., marvinator = TRUE)). If FALSE the file looked for is 'yunitator_old_X.rttm' (which is the result of divime_talkertype(..., marvinator = FALSE)). If the respective file is not found, the function aborts.

The name of the resulting output also depends on the marvinator= argument. If FALSE, the output is 'vcm_X.rttm' and if TRUE it is 'vcm_marvinator_X.rttm'. Note that the latter is different from the behaviour of the underlying script vcm.sh, which in both cases returns the same output file name. I made this modification to avoid mix-ups.

Value

a data.frame with the locations of the created rttm files and some diagnostics


gobbios/avutils documentation built on Feb. 19, 2020, 9:44 a.m.