R/reportdirectory.R

In SWS-Methodology/faoswsTrade: FAO Trade Module

#' Create directory for writing a report and supplementary files
#'
#' @param sws_user User name to include in the name.
#' @param year Year to include in the name.
#' @param build_id Identificator to include in the name.
#' @param create Should the directory be created. TRUE by default.
#' @param browsedir Should the directory be opened in system-default file
#'   browser. TRUE by default.
#'
#' @return String with full name of report directory.
#' @export
#'

reportdirectory <- function(sws_user, year, build_id, create = TRUE, browsedir = TRUE) {

  sws_share <- Sys.getenv("R_SWS_SHARE_PATH", unset = NA_character_)

  if(is.na(sws_share)) stop("System variable R_SWS_SHARE_PATH not set.")

  reportdir <- file.path(
    sws_share,
    sws_user,
    paste("complete_tf_cpc", year, build_id,
          format(Sys.time(), "%Y%m%d_%H%M"),
          sep = "_"))

  reportdir <- normalizePath(reportdir,
                             winslash='/',
                             mustWork = FALSE)

  if (file.exists(reportdir)) {
    warning('A previous reportdir exists: it will be overwritten')
  } else {
    dir.create(reportdir, recursive = TRUE)
  }

  # Open report directory in system default file browser
  if(browsedir & interactive()) browseURL(reportdir)

  reportdir

}