getLayers: Gets a list of layer definitions.

View source: R/getLayers.R

getLayersR Documentation

Gets a list of layer definitions.

Description

Gets a list of layer definitions.

Usage

getLayers(labbcat.url)

Arguments

labbcat.url

URL to the LaBB-CAT instance

Value

A list of layer definitions, with members:

  • id The layer's unique ID

  • parentId The layer's parent layer ID

  • description The description of the layer

  • alignment The layer's alignment - 0 for none, 1 for point alignment, 2 for interval alignment

  • peers Whether children have peers or not

  • peersOverlap Whether child peers can overlap or not

  • parentIncludes Whether the parent t-includes the child

  • saturated Whether children must temporally fill the entire parent duration (true) or not (false)

  • parentIncludes Whether the parent t-includes the child

  • type The type for labels on this layer

  • validLabels List of valid label values for this layer

See Also

getLayerIds

Examples

## Not run: 
## Get definitions of all layers
layers <- getLayers("https://labbcat.canterbury.ac.nz/demo/")

## End(Not run)


nzilbb.labbcat documentation built on July 26, 2023, 6:08 p.m.