add: note to function description on API limitation

vusaverse · Mar 7, 2024 · d50e5f1 · d50e5f1
1 parent 3a5c580
commit d50e5f1
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/R/download_tableau_crosstab_excel.R b/R/download_tableau_crosstab_excel.R
@@ -10,6 +10,9 @@
 #' @return NULL
 #' @family Tableau REST API
 #'
+#' @note If a crosstab is exported from a dashboard, data from only the first view in the dashboard will appear in the .xlsx file.
+#' Downloads of data from story dashboards are not supported at this time.
+#'
 #' @export
 download_tableau_crosstab_excel <- function(tableau, view_id, path_to_save, api_version = 3.16) {
   base_url <- tableau$base_url

diff --git a/man/download_tableau_crosstab_excel.Rd b/man/download_tableau_crosstab_excel.Rd