R/write_tableau.R

In zhiruiwang/RTableau: Output Data into Tableau Extract Format

# Some useful keyboard shortcuts for package authoring:
#
#   Build and Reload Package:  'Ctrl + Shift + B'
#   Check Package:             'Ctrl + Shift + E'
#   Test Package:              'Ctrl + Shift + T'

#' Write R data.frame to Tableau Extract.
#'
#' @param data input data.frame
#' @param path output path of Tableau Extract
#' @param spatial_columns index of spatial column, either number or name
#' @param spatial_indicator change spatial characteristic
#' @param add_index Add index column to Tableau Extract
#' @examples
#' \dontrun{
#' # Save iris dataset into .tde or .hyper format:
#' write_tableau(iris, file.path(tempdir(), "iris.tde"))
#'
#' }
write_tableau <- function(data, path, spatial_columns=NA, spatial_indicator=TRUE, add_index=FALSE) {
  df_tableau <- pandleau$pandleau(reticulate::r_to_py(data))
  if(!is.na(spatial_columns)){
    spatial_columns <- ifelse(is.numeric(spatial_columns),spatial_columns-1,spatial_columns)
    df_tableau$set_spatial(reticulate::r_to_py(spatial_columns), indicator=reticulate::r_to_py(spatial_indicator))
  }
  df_tableau$to_tableau(reticulate::r_to_py(path),add_index=reticulate::r_to_py(add_index))
}