add_form_names: Add form names to long format RC data

View source: R/add_form_names.R

add_form_namesR Documentation

Add form names to long format RC data

Description

Adds a form name column, taking pooled data into account. This is an internal function only

Usage

add_form_names(
  long_data,
  pooled_vars = NULL,
  data_dict = getOption("redcap_bundle")$data_dict,
  mappings = getOption("redcap_bundle")$mappings,
  id_field = getOption("redcap_bundle")$id_field
)

Arguments

long_data

Dataframe. A long format data frame, as created by rc_missing. At minimum there should be a record_id column, a redcap_event_name column, and a column containing variable names. Wide-to-long conversion functions include reshape2::melt() (used in rctools), tidyr::gather(), and tidyr::pivot_longer().

pooled_vars

Dataframe. Dataframe attribute appended to record_data by pooled_vars.

data_dict

Dataframe. REDCap project data data_dictionary. By default, this will be fetched from the REDCap bundle option, as created by rc_bundle. Otherwise, a data.frame containing the project data dictionary must be supplied.

mappings

Dataframe. Redcap metadata that maps forms to events.

id_field

Character. Field name corresponding to the 'record_id' field.

Author(s)

Marcus Lehr


chillywings/rctools documentation built on Aug. 9, 2024, 11:52 p.m.