R/example_data.R

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

# Documentation of datasets --------------------------------
# example_data_dict
#' @docType data
#' @title Example dataset of surgical patients
#' @name example_data_dict
#' @aliases example_data_dict
#' @description Example dataset to be used within the \href{https://github.com/kamclean/collaborator/blob/master/vignettes/vignette_data_dict.md}{Generating a Simple, Easily-Shareable Data Dictionary} vignette (all data randomly generated).
#' @format A data frame with 20 rows and 11 variables.
#' @usage data(example_data_dict)
#' @keywords data
NULL

# example_report_author
#' @docType data
#' @title Example dataset of authors
#' @name example_report_author
#' @aliases example_report_author
#' @description Example dataset to be used within the \href{https://github.com/kamclean/collaborator/blob/master/vignettes/vignette_authors.md}{Generating Authorship Lists} vignette (all data randomly generated).
#' @format A data frame with 100 rows and 3 variables.
#' @usage data(example_report_author)
#' @keywords data
NULL


# example_df_user
#' @docType data
#' @title Example dataset of REDCap users
#' @name example_df_user
#' @aliases example_df_user
#' @description Example dataset to be used within the \href{https://github.com/kamclean/collaborator/blob/master/vignettes/vignette_user_1_explore.md}{Redcap User Management: 1. Explore Current Users} vignette (all data randomly generated).
#' @format A data frame with 34 rows and 2 variables.
#' @usage data(example_df_user)
#' @keywords data
NULL