saveLayer {nzilbb.labbcat} | R Documentation |
Saves the details of an existing layer
Description
This function saves the definition of an existing annotation layer.
Usage
saveLayer(labbcat.url, layer)
Arguments
labbcat.url |
URL to the LaBB-CAT instance |
layer |
A named list object representing the layer attributes, as would be returned by getLayer or newLayer, with members:
|
Details
You must have administration privileges in LaBB-CAT in order to be able to use this function.
Value
The resulting layer definition, 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
Other Annotation layer functions:
deleteLayer()
,
generateLayer()
,
getLayer()
,
getLayerIds()
,
getLayers()
,
newLayer()
Examples
## Not run:
## Get the pronunciation layer definition
pronunciation <- getLayer(labbcat.url, "pronunciation")
## Change some details of the definition
pronunciation$description <- "CMU Dict pronunciations encoded in DISC"
pronunciation$type <- "ipa"
## Save the changes to the layer definition
saveLayer(labbcat.url, pronunciation)
## End(Not run)