nzilbb.labbcat (version 1.3-0)

renameParticipants: Renames a list of participants.

Description

This function changes the IDs of a given set of participants, where possible.

Usage

renameParticipants(labbcat.url, current.ids, new.ids, no.progress = FALSE)

Value

A vector of results, each element corresponding to an ID in current.ids. If the ID was successfully changed, the corresponding element is TRUE. If the ID could not be changed (e.g. because there is already an existing participant using the new ID), then the corresponding element is FALSE.

Arguments

labbcat.url

URL to the LaBB-CAT instance

current.ids

A vector of participant IDs that as they are currently defined in the corpus.

new.ids

A vector of new participant IDs, each element corresponding to an ID in current.ids.

no.progress

TRUE to supress visual progress bar. Otherwise, progress bar will be shown when interactive().

See Also

getParticipantIds getMatchingParticipantIds getParticipant saveParticipant deleteParticipant

Examples

if (FALSE) {
## define the LaBB-CAT URL
labbcat.url <- "https://labbcat.canterbury.ac.nz/demo/"

## Create some new participant records
old.ids <- c("test-id-1","test-id-2","test-id-3")
for (id in old.ids) saveParticipant(labbcat.url, id)

## Batch change the IDs
new.ids <- c("test-id-1-changed","test-id-2-changed","test-id-3-changed")
renameParticipants(labbcat.url, old.ids, new.ids)

## Delete the participants we just created
for (id in new.ids) deleteParticipant(labbcat.url, id)
}