getProjectIdFields: Return a vector of the Project ID Fields

In redcapAPI: Interface to 'REDCap'

Return a vector of the Project ID Fields

Description

Returns a character vector listing the project ID fields. This will be at most a vector of length two. The first element will be the first field in the meta data. The second, if provided, will be the name of the secondary unique field specified in the project.

Usage

getProjectIdFields(rcon)

Arguments

rcon	A redcapConnection object.

Value

Returns a character vector with the field names that uniquely identify an experimental unit.

Examples

## Not run: 
unlockREDCap(connections = c(rcon = "project_alias"), 
             url = "your_redcap_url", 
             keyring = "API_KEYs", 
             envir = globalenv())
             
getProjectIdFields(rcon)

## End(Not run)

redcapAPI documentation built on Oct. 17, 2024, 5:07 p.m.