export_BPFCollection: Exports an emuDB into a BAS Partitur File (BPF) Collection

View source: R/emuR-export_BPFCollection.R

export_BPFCollectionR Documentation

Exports an emuDB into a BAS Partitur File (BPF) Collection

Description

This function exports an emuDB into the BAS Partitur File format, with one BPF file per bundle. The user must pass a list of matching label names and BPF keys. Important: The BPF format does not support explicit hierarchies with more than three levels. Hence, you will probably lose information when exporting complex hierarchies.

Usage

export_BPFCollection(
  handle,
  targetDir,
  extractLevels,
  refLevel = NULL,
  verbose = TRUE,
  newLevels = NULL,
  newLevelClasses = NULL,
  copyAudio = FALSE
)

Arguments

handle

handle to the emuDB

targetDir

directory where the BPF collection should be saved

extractLevels

list containing the names of labels (not levels!) that should be extracted, and their matching BPF keys, e.g. extractLevels = list(SampleRate="SAM", Text="ORT", Phonemes="SAP")

refLevel

optional name of level (not label!) used as reference for symbolic links. If NULL (the default), a link-less BPF collection is created.

verbose

display infos, warnings and show progress bar

newLevels

optional vector containing names of levels in the BPF collection that are not part of the standard BPF levels. See http://www.bas.uni-muenchen.de/forschung/Bas/BasFormatseng.html#Partitur_tiersdef for details on standard BPF levels.

newLevelClasses

optional vector containing the classes of levels in the newLevels vector as integers. Must have the same length and order as newLevels.

copyAudio

if true, audio files are copied to the new BPF collection

See Also

export_TextGridCollection


emuR documentation built on Nov. 4, 2023, 1:06 a.m.