getMatchLabels {nzilbb.labbcat} | R Documentation |
Gets labels of annotations on a given layer, identified by given match IDs.
Description
Gets labels of annotations on a given layer, identified by given match IDs.
Usage
getMatchLabels(
labbcat.url,
match.ids,
layer.ids,
target.offset = 0,
annotations.per.layer = 1,
include.match.ids = FALSE,
page.length = 1000,
no.progress = FALSE
)
Arguments
labbcat.url |
URL to the LaBB-CAT instance |
match.ids |
A vector of annotation IDs, e.g. the MatchId column, or the URL column, of a results set. |
layer.ids |
A vector of layer IDs. |
target.offset |
The distance from the original target of the match, e.g.
|
annotations.per.layer |
The number of annotations on the given layer to retrieve. In most cases, there's only one annotation available. However, tokens may, for example, be annotated with ‘all possible phonemic transcriptions’, in which case using a value of greater than 1 for this parameter provides other phonemic transcriptions, for tokens that have more than one. |
include.match.ids |
Whether or not the data frame returned includes the original MatchId column or not. |
page.length |
In order to prevent timeouts when there are a large number of matches or the network connection is slow, rather than retrieving matches in one big request, they are retrieved using many smaller requests. This parameter controls the number of results retrieved per request. |
no.progress |
TRUE to supress visual progress bar. Otherwise, progress bar will be shown when interactive(). |
Value
A data frame of labels.
See Also
Examples
## Not run:
## define the LaBB-CAT URL
labbcat.url <- "https://labbcat.canterbury.ac.nz/demo/"
## Perform a search
results <- getMatches(labbcat.url, list(orthography="quake"))
## Get the topic annotations for the matches
topics <- getMatchLabels(labbcat.url, results$MatchId, "topic")
## End(Not run)