format_record: Format Record

In REDCapExporter: Automated Construction of R Data Packages from REDCap Projects

Format Record

Description

Use REDCap project metadata to build a well formatted data.frame for the record.

Usage

format_record(x, metadata = NULL, col_type = NULL, ...)

Arguments

x	a rcer_rccore, rcer_raw_record, or rcer_record object.
metadata	a rcer_metadata or rcer_raw_metadata object. Will be ignored if col_type is defined.
col_type	a rcer_col_type object.
...	other arguments passed to col_type

Value

A data.frame

See Also

export_core, export_content, vignette("formatting", package = "REDCapExporter")

Examples

data("avs_raw_metadata")
data("avs_raw_record")

# Formatting the record can be called in different ways and the same result
# will be generated
identical(
  format_record(avs_raw_record, avs_raw_metadata),
  format_record(avs_raw_core)
)

avs <- format_record(avs_raw_record, avs_raw_metadata)
avs

REDCapExporter documentation built on April 4, 2025, 2:29 a.m.