165 options #174
Merged
165 options #174
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* adds openxls_getOp() * adds op.openxlsx * adds testing * updates docs
* makes corrections to resolve options * sets most options to NULL * adds some more todos to do * formatting
|
Thank you very much. maybe we could also use package options |
jmbarbone
commented
Apr 14, 2021
Comment on lines
+59
to
+164
| #' \code{openxlsx_getOp()} retrieves the \code{"openxlsx"} options found in | ||
| #' \code{op.openxlsx}. If none are set (currently `NULL`) retrieves the | ||
| #' default option from \code{op.openxlsx}. This will also check that the | ||
| #' intended option is a standard option (listed in \code{op.openxlsx}) and | ||
| #' will provide a warning otherwise. | ||
| #' | ||
| #' \code{openxlsx_setOp()} is a safer way to set an option as it will first | ||
| #' check that the option is a standard option (as above) before setting. | ||
| #' | ||
| #' @examples | ||
| #' openxlsx_getOp("borders") | ||
| #' op.openxlsx[["openxlsx.borders"]] | ||
| #' | ||
| #' @export | ||
| #' @name openxlsx_options | ||
| op.openxlsx <- list( | ||
| openxlsx.bandedCols = FALSE, | ||
| openxlsx.bandedRows = TRUE, | ||
| openxlsx.borderColour = "black", | ||
| openxlsx.borders = NULL, | ||
| openxlsx.borderStyle = "thin", | ||
| # Where is compressionLevel called? | ||
| openxlsx.compressionLevel = 9, | ||
| openxlsx.creator = "", | ||
| openxlsx.dateFormat = "mm/dd/yyyy", | ||
| openxlsx.datetimeFormat = "yyyy-mm-dd hh:mm:ss", | ||
| openxlsx.hdpi = 300, | ||
| openxlsx.header = NULL, | ||
| openxlsx.headerStyle = NULL, | ||
| openxlsx.firstColumn = NULL, | ||
| openxlsx.firstFooter = NULL, | ||
| openxlsx.firstHeader = NULL, | ||
| openxlsx.footer = NULL, | ||
| openxlsx.evenFooter = NULL, | ||
| openxlsx.evenHeader = NULL, | ||
| openxlsx.gridLines = TRUE, | ||
| openxlsx.keepNA = FALSE, | ||
| openxlsx.lastColumn = NULL, | ||
| openxlsx.na.string = NULL, | ||
| openxlsx.numFmt = "GENERAL", | ||
| openxlsx.oddFooter = NULL, | ||
| openxlsx.oddHeader = NULL, | ||
| openxlsx.orientation = "portrait", | ||
| openxlsx.paperSize = 9, | ||
| openxlsx.showGridLines = NA, | ||
| openxlsx.tabColour = NULL, | ||
| openxlsx.tableStyle = "TableStyleLight9", | ||
| openxlsx.vdpi = 300, | ||
| openxlsx.withFilter = NULL | ||
| ) | ||
|
|
||
|
|
||
| #' @param x An option name (\code{"openxlsx."} prefix optional) | ||
| #' @param default A default value if \code{NULL} | ||
| #' @rdname openxlsx_options | ||
| #' @export | ||
| openxlsx_getOp <- function(x, default = NULL) { | ||
| if (length(x) != 1L || length(default) > 1L) { | ||
| stop("x must be length 1 and default NULL or length 1", call. = FALSE) | ||
| } | ||
|
|
||
| x <- check_openxlsx_op(x) | ||
| getOption(x, op.openxlsx[[x]]) %||% default | ||
| } | ||
|
|
||
| #' @param value The new value for the option (optional if x is a named list) | ||
| #' @rdname openxlsx_options | ||
| #' @export | ||
| openxlsx_setOp <- function(x, value) { | ||
| if (is.list(x)) { | ||
| if (is.null(names(x))) { | ||
| stop("x cannot be an unnamed list", call. = FALSE) | ||
| } | ||
|
|
||
| mapply(openxlsx_setOp, x = names(x), value = x) | ||
| } | ||
|
|
||
| value <- as.list(value) | ||
| names(value) <- check_openxlsx_op(x) | ||
| options(value) | ||
| } | ||
|
|
||
| check_openxlsx_op <- function(x) { | ||
| if (length(x) != 1L || !is.character(x)) { | ||
| stop("option must be a character vector of length 1", call. = FALSE) | ||
| } | ||
|
|
||
| if (!grepl("^openxlsx[.]", x)) { | ||
| x <- paste0("openxlsx.", x) | ||
| } | ||
|
|
||
| if (!x %in% names(op.openxlsx)) { | ||
| warning( | ||
| x, " is not a standard openxlsx option\nCheck spelling", | ||
| call. = FALSE | ||
| ) | ||
| } | ||
|
|
||
| x | ||
| } |
There was a problem hiding this comment.
Thank you very much.
maybe we could also use package options
@ycphs Not quite sure what you mean. These functions use the option() function for setting the global options. There is an additional step in which openxlsx_getOp() and openxlsx_setOp() also check that the option is present in the op.openxlsx object to validate the name is given appropriately (I had seen a few instances of trying to retrieve options with names like dateTimeFormat and datetimeFormat. Users are still free to use either approach:
# explicitly adding the openxlsx. prefix
op1 <- list(openxlsx.gridLines = FALSE, openxlsx.withFilter = FALSE)
op2 <- list(gridLines = FALSE, withFilter = FALSE)
options(op1) # valid and works fine
options(op2) # valid but won't set the openxlsx options
# appends the openxlsx. prefix is not provided, results are the same
openxlsx_setOps(op1)
openxlsx_setOps(op2)
openxlsx_setOps(withfilter = FALSE) # will throw a warning because the name isn't exactly rightAnother example of this sort of implementation is in the tibble package.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #165
A few notes:
openxlsx_getOp()is a safe way to retrieve an openxlsx optionop.openxlsxfirst -- this should prevent misspellings (already has for me)defaultcan be assigned forNULLvalues -- which will also make the function defaults visible.onAttach()op.openxlsxobject so make all options user facing (although more descriptions can probably be added)