Add cross-refs to related functions

Author: alice-hannah

R/assets.R

@@ -20,6 +20,8 @@
 #'
 #' @return A tibble
 #'
+#' @family Asset functions
+#'
 #' @export
 
 assets <- function(workspace_uuid,
@@ -75,6 +77,8 @@ assets <- function(workspace_uuid,
 #'
 #' @return A tibble
 #'
+#' @family Asset functions
+#'
 #' @export
 
 asset_info <- function(asset_uuid,
@@ -108,6 +112,8 @@ asset_info <- function(asset_uuid,
 #'
 #' @return API response (invisibly)
 #'
+#' @family Asset functions
+#'
 #' @export
 
 delete_asset <- function(asset_uuid,
@@ -144,6 +150,8 @@ delete_asset <- function(asset_uuid,
 #'
 #' @return API response (invisibly)
 #'
+#' @family Asset functions
+#'
 #' @export
 
 rename_asset <- function(asset_uuid,

R/bypass_2fa.R

@@ -16,6 +16,8 @@
 #'
 #' @return API response (invisibly)
 #'
+#' @family Two-factor authentication functions
+#'
 #' @export
 
 workgroup_bypass_2fa <- function(workgroup_uuid,
@@ -63,6 +65,8 @@ workgroup_bypass_2fa <- function(workgroup_uuid,
 #'
 #' @return API response (invisibly)
 #'
+#' @family Two-factor authentication functions
+#'
 #' @export
 
 participant_bypass_2fa <- function(participant_uuid,
@@ -106,6 +110,8 @@ participant_bypass_2fa <- function(participant_uuid,
 #'
 #' @return API response (invisibly)
 #'
+#' @family Two-factor authentication functions
+#'
 #' @export
 
 workgroup_mandate_2fa <- function(workgroup_uuid,

R/comments.R

@@ -21,6 +21,8 @@
 #' comments()
 #' }
 #'
+#' @family Comment functions
+#'
 #' @export
 
 comments <- function(created_after = NULL,
@@ -78,6 +80,8 @@ comments <- function(created_after = NULL,
 #'
 #' @return API response (invisibly)
 #'
+#' @family Comment functions
+#'
 #' @export
 
 new_thread <- function(workspace_uuid,
@@ -121,6 +125,7 @@ new_thread <- function(workspace_uuid,
 #'
 #' @return API response (invisibly)
 #'
+#' @family Comment functions
 #' @export
 
 new_reply <- function(thread_uuid,

R/create_folder.R

@@ -16,6 +16,8 @@
 #'
 #' @return API response (invisibly)
 #'
+#' @family Asset functions
+#'
 #' @export
 
 create_folder <- function(folder_name,

R/download.R

@@ -84,6 +84,8 @@ download_helper <- function(document_uuid,
 #'
 #' @return Path to downloaded file (invisibly).
 #'
+#' @family Read/write functions
+#'
 #' @export
 
 download_file <- function(document_uuid,
@@ -166,6 +168,8 @@ download_file_version <- function(document_uuid,
 #'
 #' @return A [tibble][tibble::tibble-package].
 #'
+#' @family Read/write functions
+#'
 #' @export
 
 read_data <- function(document_uuid,

R/mobile_auth.R

@@ -15,6 +15,8 @@
 #' * `mobileAuthLogin`: Has the user enabled login via Mobile Authenticator?
 #' * `mobileAuthRegistered`: Has the user registered a Mobile Authenticator?
 #'
+#' @family Mobile authentication functions
+#'
 #' @export
 
 mobile_auth_status <- function(use_proxy = FALSE) {
@@ -49,6 +51,8 @@ mobile_auth_status <- function(use_proxy = FALSE) {
 #'
 #' @return API response (invisibly)
 #'
+#' @family Mobile authentication functions
+#'
 #' @export
 
 mobile_auth_login <- function(code = NULL, use_proxy = FALSE) {

R/participants.R

@@ -11,6 +11,8 @@
 #'
 #' @return A tibble
 #'
+#' @seealso [add_participants()]
+#'
 #' @export
 
 participants <- function(workspace_uuid, use_proxy = FALSE) {
@@ -86,6 +88,8 @@ participants <- function(workspace_uuid, use_proxy = FALSE) {
 #'
 #' @return API response (invisibly)
 #'
+#' @seealso [participants()]
+#'
 #' @export
 
 add_participants <- function(workspace_uuid,

R/upload.R

@@ -26,6 +26,8 @@
 #'
 #' @return API response (invisibly)
 #'
+#' @family Read/write functions
+#'
 #' @export
 
 upload_file <- function(file,
@@ -150,6 +152,8 @@ upload_file_version <- function(file,
 #'
 #' @return API response (invisibly)
 #'
+#' @family Read/write functions
+#'
 #' @export
 
 write_data <- function(x,

R/documents.R R/versions.RR/documents.R renamed to R/versions.R

@@ -12,6 +12,8 @@
 #'
 #' @return A tibble
 #'
+#' @seealso [rollback_to_version()]
+#'
 #' @export
 
 versions <- function(document_uuid,
@@ -63,6 +65,8 @@ versions <- function(document_uuid,
 #'
 #' @return API response (invisibly)
 #'
+#' @seealso [versions()]
+#'
 #' @export
 
 rollback_to_version <- function(document_uuid,