report_miss: Generate a missing data report for a REDCap project.

In kamclean/collaborator: Scalable multi-centre research using R and REDCap

Generate a missing data report for a REDCap project.

Description

Used to generate a report of record-level + redcap_data_access_group-level missing data within a REDCap project (which accounts for branching logic in the dataframe).

Usage

report_miss(
  redcap_project_uri,
  redcap_project_token,
  missing_threshold = 0.05,
  var_include = NULL,
  var_exclude = NULL,
  record_exclude = NULL,
  record_include = NULL,
  dag_include = NULL,
  dag_exclude = NULL,
  record_id = "record_id"
)

Arguments

redcap_project_uri	URI (Uniform Resource Identifier) for the REDCap instance.
redcap_project_token	API (Application Programming Interface) for the REDCap project.
missing_threshold	The overall proportion of missing data that is acceptable (default = 0.05).
var_include	Vector of names of variables that are desired to be specifically used to assess data completness (alternate method from using "var_exclude").
var_exclude	Vector of names of variables that are desired to be excluded from assessment of data completness (any NA value will be counted as incomplete).
record_exclude	Vector of redcap record_id that are desired to be excluded from the record count.
record_include	Vector of redcap record_id that are desired to be included in the record count.
dag_include	Vector of redcap data access group names that are desired to be included in the record count.
dag_exclude	Vector of redcap data access group names that are desired to be excluded from the record count.
record_id	String of variable name which fufills the record_id role (default = "record_id")

Value

Nested dataframe with a summary of missing data at the redcap_data_access_group level and the record level.

kamclean/collaborator documentation built on June 25, 2024, 8:38 a.m.