saveLabelsFromLongFormat: Save labels from a long format

View source: R/longFormatSave.R

saveLabelsFromLongFormatR Documentation

Save labels from a long format

Description

This function saves labels to the database specified in applicationSettings

Usage

saveLabelsFromLongFormat(entityData, entityKind, stateGroups, idColumn,
  recordedBy, lsTransaction, stateGroupIndices = NULL, labelPrefix = NULL)

Arguments

entityData

a data.frame, including one column named 'stateGroupIndex', one that matches idColumn, and one of the form 'entityID'

entityKind

a string, the kind of the state, limited to "protocol", "experiment", "analysisgroup", "treatmentgroup", "subject", "container", "itxcontainercontainer"

stateGroups

a list of lists, each of which includes details about how to save states (TODO link later)

idColumn

a string, the name of the column used to separate states (often stateID)

recordedBy

a string, the name of the person recording the data

lsTransaction

an integer, the id of the lsTransaction

stateGroupIndices

an integer vector of indices to use from stateGroups

labelPrefix

a string, prefixed to all labels


mcneilco/racas documentation built on April 19, 2024, 1:12 p.m.