camr_SWA_linking_code_performance: Summary of Linking of Records

In rettopnivek/camrprojects: Portable Functions for R Projects at CAM-MGH

Summary of Linking of Records

Description

Function to summarize the performance of the linking code for the school-wide assessment. Provides summary statistics for what records were linked, and if columns with the 'true' IDs are detected, provides details on hits and correct rejections.

Usage

camr_SWA_linking_code_performance(
  dtf_linked,
  lst_groups = list(Time = "SSS.INT.Time_point")
)

Arguments

dtf_linked	A data frame, the output from camr_SWA_linking_code.
lst_groups	A named list of column names, the grouping factors to consider when summarizing the number of records linked.
lgc_display	A logical value; if TRUE prints the results to the console in addition to returning output as a list.

Value

A list of data frames.

Examples

# Linking across time points
dtf_long <- camr_SWA_linking_code_simulate('demo')
dtf_linked <- camr_SWA_linking_code(dtf_long)
lst_summary <- camr_SWA_linking_code_performance(
  dtf_linked, lgc_display = FALSE
)

rettopnivek/camrprojects documentation built on June 9, 2025, 4 p.m.