redcap_sum: Generate REDCap summary data.

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

Generate REDCap summary data.

Description

Used to generate high quality summary data for REDCap projects at overall, and DAG-specific level.

Usage

redcap_sum(
  redcap_project_uri = NULL,
  redcap_project_token = NULL,
  centre_sum = TRUE,
  top = 10,
  var_include = NULL,
  var_exclude = NULL,
  user_include = NULL,
  user_exclude = NULL,
  dag_exclude = NULL,
  dag_include = NULL,
  record_include = NULL,
  record_exclude = NULL
)

Arguments

redcap_project_uri	URI (Uniform Resource Identifier) for the REDCap instance.
redcap_project_token	API (Application Programming Interface) for the REDCap project.
centre_sum	Logical value to determine whether data access group-level summaries will be produced (Default = TRUE).
top	When centre_sum = TRUE, defines output of the number of centres with the most records uploaded (default is top 10).
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).
user_include	Vector of redcap usernames that are desired to be included in the user count (note all users not assigned to a DAG will automatically be excluded).
user_exclude	Vector of redcap usernames that are desired to be excluded from the user count (note all users not assigned to a DAG will automatically be excluded).
dag_exclude	Vector of redcap data access group names that are desired to be excluded from the record count.
dag_include	Vector of redcap data access group names that are desired to be included in the record count.
record_include	Vector of redcap record_id that are desired to be included in the record count.
record_exclude	Vector of redcap record_id that are desired to be excluded from the record count.

Value

Nested dataframes of (i) overall summary statistics for the project ("sum_overall") (ii). DAG-specific summary statistics for the project ("dag_all") (iii). DAGs with no data uploaded, but users assigned ("dag_nodata") (iv). DAGs with <100

kamclean/collaborator documentation built on Nov. 17, 2023, 3:52 a.m.