read_redcap_metadata: Read in metadata from Redcap project via Redcap API

In antchau/glider: Utility Functions for Usage with Wadwha Research Group

Description

Read in metadata from Redcap project via Redcap API

Usage

read_redcap_metadata(uri, token_name, fields = NULL, forms = NULL)

Arguments

uri	A link to a Redcap server.
fields	A string or a vector of strings. Indicates desired fields to query from REDCAP project.
forms	A string or a vector of strings. Indicates desired forms to query from REDCAP project.
token	A string that stores the API key which grants access to a REDCAP project.

Value

A data frame containing metadata for a Redcap project. Four columns are returned: field_name, form_name, field_label, and select_choices_or_calculations.

Examples

read_redcap_metadata(uri = "path/to/Redcap/API/Server", token = "NAME_OF_TOKEN_IN_RENVIRON")
mapply(read_redcap_metadata, token = get_environment_vars("^REDCAP"), uri = "path/to/Redcap/API/Server")

antchau/glider documentation built on Dec. 1, 2020, 9:23 p.m.