nzilbb.labbcat (version 1.3-0)

annotatorExt: Retrieve annotator's "ext" resource.

Description

Retrieve a given resource from an annotator's "ext" web app. Annotators are modules that perform different annotation tasks, and can optionally implement functionality for providing extra data or extending functionality in an annotator-specific way. If the annotator implements an "ext" web app, it can provide resources and implement a mechanism for iterrogating the annotator. This function provides a mechanism for accessing these resources via R.

Usage

annotatorExt(labbcat.url, annotator.id, resource, parameters = NULL)

Value

The resource requested.

Arguments

labbcat.url

URL to the LaBB-CAT instance.

annotator.id

ID of the annotator to interrogate.

resource

The name of the file to retrieve or instance method (function) to invoke. Possible values for this depend on the specific annotator being interrogated.

parameters

Optional list of ordered parameters for the instance method (function).

Examples

if (FALSE) {
## Get the version of the currently installed LabelMapper annotator:
annotatorExt(labbcat.url, "LabelMapper", "getVersion")

## Get the summary of the segment to speakerDependentPhone mapping
## implemented by the LabelMapper annotator:
summaryJson <- annotatorExt(labbcat.url,
              "LabelMapper", "summarizeMapping", list("segment","speakerDependentPhone"))
summary <- jsonlite::fromJSON(summaryJson)
}