getPreferredId2: Gets preferred ids

getPreferredId2R Documentation

Gets preferred ids

Description

Entered entity codes (ids) are checked against a preferred id service.

Usage

getPreferredId2(entityIds, displayName, testMode = FALSE,
  preferredIdService = NULL)

Arguments

displayName

the user display name of the codes (e.g. "Compound Batch ID")

testMode

unused testing tool

preferredIdService

the url of the preferred id service. Defaults to paste0(racas::applicationSettings$server.nodeapi.path, "/api/entitymeta/preferredCodes")

batchIds

a character vector of codes

Details

Gets preferred id's for a range for inputs. For compound/batch name requests, it will use the relevant batch code check. For lsThings, it checks those entities for their preferred codes.

Value

a data.frame with names c("Requested.Name", "Preferred.Code")


mcneilco/racas documentation built on May 4, 2024, 9:53 p.m.