nzilbb.labbcat (version 0.6-3)

getFragments: Gets fragments of annotation transcript from 'LaBB-CAT', converted to a given format (by default, Praat TextGrid)

Description

Gets fragments of annotation transcript from 'LaBB-CAT', converted to a given format (by default, Praat TextGrid)

Usage

getFragments(
  labbcat.url,
  id,
  start,
  end,
  layerIds,
  mimeType = "text/praat-textgrid",
  no.progress = FALSE,
  path = ""
)

Arguments

labbcat.url

URL to the LaBB-CAT instance

id

The transcript ID (transcript name) of the sound recording, or a vector of transcript IDs.

start

The start time in seconds, or a vector of start times.

end

The end time in seconds, or a vector of end times.

layerIds

A vector of layer IDs.

mimeType

Optional content-type - "text/praat-textgrid" is the default, but your LaBB-CAT installation may support other formats, which can be discovered using getSerializerDescriptors.

no.progress

Optionally suppress the progress bar when multiple fragments are specified - TRUE for no progress bar.

path

Optional path to directory where the files should be saved.

Value

The name of the file, which is saved in the current directory, or a list of names of files, if multiple id's/start's/end's were specified

If a list of files is returned, they are in the order that they were returned by the server, which *should* be the order that they were specified in the id/start/end lists.

See Also

getSerializerDescriptors

Examples

# NOT RUN {
## define the LaBB-CAT URL
labbcat.url <- "https://labbcat.canterbury.ac.nz/demo/"

## Get the 5 seconds starting from 10s after the beginning of a recording
textgrid.file <- getFragments(labbcat.url, "AP2505_Nelson.eaf", 10.0, 15.0,
    c("transcript", "phonemes"), path="samples") 

## Load some search results previously exported from LaBB-CAT
results <- read.csv("results.csv", header=T)

## Get a list of fragment TextGrids, including the utterances, transcript, and phonemes layers
textgrid.files <- getFragments(
    labbcat.url, results$Transcript, results$Line, results$LineEnd,
    c("utterances", "transcript", "phonemes"))

## Get a list of fragment TextGrids with no progress bar
textgrid.files <- getFragments(
    labbcat.url, results$Transcript, results$Line, results$LineEnd, no.progress=TRUE)
# }