fix: missing @export tags in functions

vusaverse · Jan 9, 2024 · 9f83556 · 9f83556
1 parent a18d69a
commit 9f83556
Show file tree

Hide file tree

Showing 39 changed files with 148 additions and 0 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -7,9 +7,11 @@ export(add_user_to_group)
 export(add_user_to_site)
 export(adjust_tableau_font_style)
 export(adjust_tableau_size)
+export(authenticate_PAT)
 export(authenticate_server)
 export(check_dashboard_names)
 export(create_group)
+export(delete_group)
 export(download_filtered_tableau_image)
 export(download_tableau_crosstab_excel)
 export(download_tableau_data)
@@ -38,13 +40,15 @@ export(get_server_views)
 export(get_server_workbooks)
 export(get_table_assets)
 export(get_tableau_data_source)
+export(get_users_in_group)
 export(get_variable_folders)
 export(get_variables)
 export(get_workbook_id)
 export(get_workbook_tabs)
 export(make_rootnodes)
 export(query_user_on_site)
 export(remove_user_from_group)
+export(remove_user_from_site)
 export(update_group)
 export(update_user)
 importFrom(magrittr,"%>%")
diff --git a/R/authenticate_PAT.R b/R/authenticate_PAT.R
@@ -8,6 +8,8 @@
 #' @param base_url The base URL of the Tableau server or Tableau cloud. For Tableau Server, this is usually the URL of the Tableau server. For Tableau Cloud, this is usually the URL of the Tableau cloud, and it must contain the pod name, such as 10az, 10ay, or us-east-1. For example, the base URL to sign in to a site in the 10ay pod would be: https://10ay.online.tableau.com.
 #' @param api_version the api version to use. Default is 3.4
 #' @return A list containing the base URL, the access token, the site ID, and the user ID.
+#' @export
+#' @family Tableau REST API
 authenticate_PAT <- function(pat_name, pat_secret, content_url, base_url, api_version = 3.4) {
   constructXML <- function(pat_name, pat_secret, content_url) {
     credentials <- paste0(

diff --git a/R/delete_group.R b/R/delete_group.R
@@ -5,6 +5,8 @@
 #' @param tableau A list containing the Tableau authentication variables: `base_url`, `token`, `user_id`, and `site_id`.
 #' @param group_id The ID of the group to delete.
 #' @param api_version The API version to use (default: 3.19).
+#' @export
+#' @family Tableau REST API
 delete_group <- function(tableau, group_id, api_version = 3.19) {
   base_url <- tableau$base_url
   site_id <- tableau$site_id

diff --git a/R/get_users_in_group.R b/R/get_users_in_group.R
@@ -9,6 +9,7 @@
 #' @param page_number The offset for paging. The default is 1.
 #'
 #' @return A list of users in the specified group.
+#' @export
 #'
 #' @family Tableau REST API
 get_users_in_group <- function(tableau, api_version = 3.19, group_id, page_size = 100, page_number = 1) {

diff --git a/R/remove_user_from_site.R b/R/remove_user_from_site.R
@@ -8,6 +8,7 @@
 #' @param mapAssetsTo Optional. The ID of a user that receives ownership of contents of the user being removed.
 #'
 #' @return No return value.
+#' @export
 #'
 #' @family Tableau REST API
 remove_user_from_site <- function(tableau, api_version = 3.19, user_id, mapAssetsTo = NULL) {

diff --git a/man/add_tags_to_view.Rd b/man/add_tags_to_view.Rd
diff --git a/man/add_tags_to_workbook.Rd b/man/add_tags_to_workbook.Rd
diff --git a/man/add_user_to_group.Rd b/man/add_user_to_group.Rd
diff --git a/man/add_user_to_site.Rd b/man/add_user_to_site.Rd
diff --git a/man/authenticate_PAT.Rd b/man/authenticate_PAT.Rd
diff --git a/man/authenticate_server.Rd b/man/authenticate_server.Rd
diff --git a/man/create_group.Rd b/man/create_group.Rd
diff --git a/man/delete_group.Rd b/man/delete_group.Rd
diff --git a/man/download_filtered_tableau_image.Rd b/man/download_filtered_tableau_image.Rd
diff --git a/man/download_tableau_crosstab_excel.Rd b/man/download_tableau_crosstab_excel.Rd
diff --git a/man/download_tableau_data.Rd b/man/download_tableau_data.Rd
diff --git a/man/download_workbooks_server.Rd b/man/download_workbooks_server.Rd
diff --git a/man/download_workbooks_server_pdf.Rd b/man/download_workbooks_server_pdf.Rd
diff --git a/man/download_workbooks_server_powerpoint.Rd b/man/download_workbooks_server_powerpoint.Rd
diff --git a/man/get_groups_for_user.Rd b/man/get_groups_for_user.Rd
diff --git a/man/get_server_connected_apps.Rd b/man/get_server_connected_apps.Rd
diff --git a/man/get_server_datasources.Rd b/man/get_server_datasources.Rd
diff --git a/man/get_server_groups.Rd b/man/get_server_groups.Rd
diff --git a/man/get_server_info.Rd b/man/get_server_info.Rd
diff --git a/man/get_server_jobs.Rd b/man/get_server_jobs.Rd
diff --git a/man/get_server_projects.Rd b/man/get_server_projects.Rd
diff --git a/man/get_server_refresh_tasks.Rd b/man/get_server_refresh_tasks.Rd
diff --git a/man/get_server_schedules.Rd b/man/get_server_schedules.Rd
diff --git a/man/get_server_user_favorites.Rd b/man/get_server_user_favorites.Rd
diff --git a/man/get_server_users.Rd b/man/get_server_users.Rd