validIdentifiers: Test if proposed identifiers have already been used in the...

Description Usage Arguments Details Value Author(s)

View source: R/validIdentifiers.R

Description

Test if proposed identifiers have already been used in the TGR, or in your data access group specifically. You must provide an array of identifiers you'd like to use, specify what type of identifier it is, and also whether you want to test if the identifiers are unique in the entire repository (such as for molecular_id), or just unique to your data access group (such as molecular_id, subject_id, biospecimen_id, or assay_material_id). The function will return only those identifiers in your array that are valid for use. FYI: Querying over the entire repository will require admin credentials.

Usage

1
validIdentifiers(x, type = "molecular_id", DAG = NULL)

Arguments

x

Character vector of proposed identifiers.

type

Identifier type to query, choose one of: 'subject_id','biospecimen_id', 'assay_material_id', or 'molecular_id'.

DAG

Data access group to query for uniqueness. Do not supply DAG to test for uniqueness across the entire Repository. If you do not have admin credentials you MUST provide a DAG.

Details

Some conditions may require **admin** REDCap credentials to be set in the environment. Please check with an admin to ensure molecular_id's are unique across the entire system.

Value

Returns any identifiers supplied that are NOT already used, thus are valid for use.

Author(s)

Amy Paguirigan


FredHutch/tgR documentation built on Oct. 5, 2021, 8:39 a.m.