meta_repeating: Fetch repeating instrument names and labels for a REDCap...

In epicentre-msf/redcap: R Utilities For REDCap

Fetch repeating instrument names and labels for a REDCap project

Description

Execute an "Export Repeating Instruments and Events" API request to fetch a tibble-style data frame containing repeating instrument names and labels.

Usage

meta_repeating(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 2 columns:

• instrument_name

• instrument_label

Examples

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

meta_repeating(conn)

## End(Not run)

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