1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
format.env <- new.env()
format.env$DataFrame <- NULL
#' Choose the format for certain objects
#'
#' Alter the format used to save DataFrames in its \code{\link{stageObject}} methods.
#'
#' @param format String containing the format to use.
#' Tbe \code{"csv"}, \code{"csv.gz"} (default) or \code{"hdf5"}.
#' Alternatively \code{NULL}, to use the default format.
#'
#' @return
#' If \code{format} is missing, a string containing the current format is returned, or \code{NULL} to use the default format.
#'
#' If \code{format} is supplied, it is used to define the current format, and the \emph{previous} format is returned.
#'
#' @details
#' \code{\link{stageObject}} methods will treat a \code{format=NULL} in the same manner as the default format.
#' The distinction exists to allow downstream applications to set their own defaults while still responding to user specification.
#' For example, an application can detect if the existing format is \code{NULL}, and if so, apply another default via \code{.saveDataFrameFormat}.
#' On the other hand, if the format is not \code{NULL}, this is presumably specified by the user explicitly and should be respected by the application.
#'
#' @author Aaron Lun
#'
#' @examples
#' (old <- .saveDataFrameFormat())
#'
#' .saveDataFrameFormat("hdf5")
#' .saveDataFrameFormat()
#'
#' # Setting it back.
#' .saveDataFrameFormat(old)
#'
#' @name saveFormats
#' @aliases .saveDataFrameFormat
NULL
#' @export
#' @rdname saveFormats
saveDataFrameFormat <- function(format) {
.save_format(format, "DataFrame", c("csv", "csv.gz", "hdf5"))
}
.save_format <- function(format, mode, choices) {
previous <- format.env[[mode]]
if (missing(format)) {
previous
} else {
if (!is.null(format)) {
format <- match.arg(format, choices)
}
format.env[[mode]] <- format
invisible(previous)
}
}
# Soft-deprecated back-compatibility fixes.
#' @export
.saveDataFrameFormat <- function(...) saveDataFrameFormat(...)
|
