user_summarise: Summarise the REDCap user dataframe by group (data access...

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

Summarise the REDCap user dataframe by group (data access group)

Description

Group current REDCap project users by DAG (and role) to provide a summarised dataframe of users, names, and emails.

Usage

user_summarise(
  redcap_project_uri,
  redcap_project_token,
  user_exclude = NULL,
  role_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.
user_exclude	Vector of usernames to be excluded e.g. those with unique rights (default = NULL).
data	Dataset previously exported of users authorized for a project (5 required columns: data_access_group, username, firstname, lastname, email)
use_ssl	Logical value whether to verify the peer's SSL certificate should be evaluated during the API pull (default=TRUE)

Value

Dataframe summarising the user dataframe by group (data access group), number of users, and username/fullname/emails (separated by ";").

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