Add constants related to user rights

ref #163; ref #217

R/constant.R

@@ -27,7 +27,24 @@
 #'
 #' REDCapR::constant("form_incomplete")  # Returns 0L
 #' REDCapR::constant("form_unverified")  # Returns 1L
-#' REDCapR::constant("form_complete")    # Returns 2L
+#' REDCapR::constant("form_complete"  )  # Returns 2L
+#'
+#' # Adapt for your institution's server:
+#' #   https://bbmc.ouhsc.edu/redcap/api/help/?content=exp_users
+#' REDCapR::constant("data_export_rights_no_access"   )  # Returns 0L
+#' REDCapR::constant("data_export_rights_deidentified")  # Returns 1L
+#' REDCapR::constant("data_export_rights_full"        )  # Returns 2L
+#'
+#' # Adapt for your institution's server:
+#' #   https://bbmc.ouhsc.edu/redcap/api/help/?content=exp_users
+#' REDCapR::constant("form_rights_no_access")  # Returns 0L
+#' REDCapR::constant("form_rights_readonly" )  # Returns 1L
+#' REDCapR::constant("form_rights_readwrite")  # Returns 2L
+#'
+#' # Adapt for your institution's server:
+#' #   https://bbmc.ouhsc.edu/redcap/api/help/?content=exp_users
+#' REDCapR::constant("access_no" )  # Returns 0L
+#' REDCapR::constant("access_yes")  # Returns 1L
 #'
 #' REDCapR::constant(c("form_complete", "form_complete", "form_incomplete")) # Returns c(2L, 2L, 0L)
 #'
@@ -62,5 +79,19 @@ constant <- function( name, simplify=TRUE ) {
 constant_list <- list(
   form_incomplete       = 0L,
   form_unverified       = 1L,
-  form_complete         = 2L
+  form_complete         = 2L,
+
+  # https://bbmc.ouhsc.edu/redcap/api/help/?content=exp_users
+  data_export_rights_no_access    = 0L,
+  data_export_rights_deidentified = 1L,
+  data_export_rights_full         = 2L,
+
+  # https://bbmc.ouhsc.edu/redcap/api/help/?content=exp_users
+  form_rights_no_access    = 0L,
+  form_rights_readonly     = 1L,
+  form_rights_readwrite    = 2L,
+
+  # https://bbmc.ouhsc.edu/redcap/api/help/?content=exp_users
+  access_no    = 0L,
+  access_yes   = 1L
 )