meta_mapping: Fetch instrument-event mappings for a REDCap project

In epicentre-msf/redcap: R Utilities For REDCap

Fetch instrument-event mappings for a REDCap project

Description

Execute an "Export Instrument-Event Mappings" API request to fetch a tibble-style data frame containing the mapping between instruments and events. Note that this request type is not available for 'classic projects', from which event details cannot be exported.

Usage

meta_mapping(conn, on_error = "fail")

Arguments

conn	A REDCap API connection object (created with rconn)
on_error	How to handle errors returned by the API (e.g. events cannot be exported for classic projects). Set to "fail" to halt execution and return the API error message, or "null" to ignore the error and return NULL. Defaults to "fail".

Value

A tibble-style data frame with 3 columns:

• arm_num

• unique_event_name

• form

Examples

## Not run: 
conn <- rconn(
  url = "https://redcap.msf.fr/api/",
  token = Sys.getenv("MY_REDCAP_TOKEN")
)

meta_mapping(conn)

## End(Not run)

epicentre-msf/redcap documentation built on April 13, 2025, 3:27 a.m.