R/f_compress_pbix.R

In pbixr: Access Data and Metadata from 'Microsoft' 'Power BI' Documents

#' @title Convert a Collection of Files to a '.pbix'
#' @description A collection of files from, or similar in structure to, a
#' decompressed '.pbix' is compressed, generating a '.pbix'.
#' @author Don Diproto
#' @param collection_files_pbix Directory of the collection of files.
#' @param output_pbix Path of the modified '.pbix'.
#' @return None
#' @importFrom zip zipr
#' @export
#' @examples
#' \dontrun{
#' # Get dummy data ------------------------------------------------------------
#' # Create a temporary directory
#' temp_dir <- file.path(tempdir(),"functionTest")
#' if(!dir.exists(temp_dir)) {
#' 	dir.create(temp_dir)
#' }
#' sample_file_name <- "OR_sample_func.pbix"
#' pathFileSample <- file.path(temp_dir, sample_file_name)
#'
#' # See if dummy data already exists in temporary directory
#' parent_temp_dir <- dirname(temp_dir)
#' existing_file <- list.files(parent_temp_dir,
#' pattern = sample_file_name, recursive = TRUE, full.names = TRUE)
#'
#' # Download the sample .pbix if it doesn't exist
#' if (length(existing_file) == 0) {
#'    url_pt1 <- "https://github.com/KoenVerbeeck/PowerBI-Course/blob/"
#'    url_pt2 <- "master/pbix/TopMovies.pbix?raw=true"
#'    url <- paste0(url_pt1, url_pt2)
#'    req <- download.file(url, destfile = pathFileSample, mode = "wb")
#' } else {
#'    pathFileSample <- existing_file[1]
#' }
#' # Do stuff ------------------------------------------------------------------
#'
#' pathFileSampleMod2 <- file.path(temp_dir, "sample_modified_f30.pbix")
#' dirFileSampleMod2 <- file.path(temp_dir, "sample_modified2_f30")
#' if(file.exists(pathFileSampleMod2) ) {
#'   file.remove(pathFileSampleMod2)
#' }
#' if(dir.exists(dirFileSampleMod2)) {
#'   unlink(dirFileSampleMod2, recursive = TRUE)
#' }
#' # Run the function
#' f_compress_pbix(dirFileSampleMod2, pathFileSampleMod2)
#'   }
f_compress_pbix <- function(collection_files_pbix, output_pbix) {
  temp_zip_name <- gsub("[.]pbix", ".zip", output_pbix)
  files_to_zip <- dir(collection_files_pbix, full.names = TRUE)
  zip::zipr(zipfile = temp_zip_name, files = files_to_zip,
            include_directories = FALSE, compression_level = 9, recurse = TRUE)
  # Change from .zip to .pbix
  file.rename(temp_zip_name, output_pbix)
}