Nothing
#' @title Round the numeric columns in a data.frame.
#'
#' @description
#' Can run on any data.frame with at least one numeric column. This function defaults to excluding the first column of the input data.frame, assuming that it contains a descriptive variable, but this can be overridden by specifying the columns to round in the \code{...} argument.
#'
#' If you're formatting percentages, e.g., the result of \code{adorn_percentages()}, use \code{adorn_pct_formatting()} instead. This is a more flexible variant for ad-hoc usage. Compared to \code{adorn_pct_formatting()}, it does not multiply by 100 or pad the numbers with spaces for alignment in the results data.frame. This function retains the class of numeric input columns.
#'
#' @param dat a \code{tabyl} or other data.frame with similar layout. If given a list of data.frames, this function will apply itself to each data.frame in the list (designed for 3-way \code{tabyl} lists).
#' @param digits how many digits should be displayed after the decimal point?
#' @param rounding method to use for rounding - either "half to even", the base R default method, or "half up", where 14.5 rounds up to 15.
#' @param ... columns to adorn. This takes a tidyselect specification. By default, all numeric columns (besides the initial column, if numeric) are adorned, but this allows you to manually specify which columns should be adorned, for use on a data.frame that does not result from a call to \code{tabyl}.
#'
#' @return Returns the data.frame with rounded numeric columns.
#' @export
#' @examples
#'
#' mtcars %>%
#' tabyl(am, cyl) %>%
#' adorn_percentages() %>%
#' adorn_rounding(digits = 2, rounding = "half up")
#'
#' # tolerates non-numeric columns:
#' library(dplyr)
#' mtcars %>%
#' tabyl(am, cyl) %>%
#' adorn_percentages("all") %>%
#' mutate(dummy = "a") %>%
#' adorn_rounding()
#'
#' # Control the columns to be adorned with the ... variable selection argument
#' # If using only the ... argument, you can use empty commas as shorthand
#' # to supply the default values to the preceding arguments:
#' cases <- data.frame(
#' region = c("East", "West"),
#' year = 2015,
#' recovered = c(125, 87),
#' died = c(13, 12)
#' )
#'
#' cases %>%
#' adorn_percentages(,,ends_with("ed")) %>%
#' adorn_rounding(,,one_of(c("recovered", "died")))
adorn_rounding <- function(dat, digits = 1, rounding = "half to even", ...) {
# if input is a list, call purrr::map to recursively apply this function to each data.frame
if (is.list(dat) && !is.data.frame(dat)) {
purrr::map(dat, adorn_rounding, digits, rounding, ...)
} else {
# catch bad inputs
if (!is.data.frame(dat)) {
stop("adorn_rounding() must be called on a data.frame or list of data.frames")
}
if (!rounding %in% c("half to even", "half up")) {
stop("'rounding' must be one of 'half to even' or 'half up'")
}
numeric_cols <- which(vapply(dat, is.numeric, logical(1)))
non_numeric_cols <- setdiff(1:ncol(dat), numeric_cols)
numeric_cols <- setdiff(numeric_cols, 1) # assume 1st column should not be included so remove it from numeric_cols. Moved up to this line so that if only 1st col is numeric, the function errors
if(rlang::dots_n(...) == 0){
cols_to_round <- numeric_cols
} else {
expr <- rlang::expr(c(...))
cols_to_round <- tidyselect::eval_select(expr, data = dat)
if(any(cols_to_round %in% non_numeric_cols)){
message("At least one non-numeric column was specified and will not be modified.")
cols_to_round <- setdiff(cols_to_round, non_numeric_cols)
}
}
if (rounding == "half to even") {
dat[cols_to_round] <- lapply(dat[cols_to_round], function(x) round(x, digits = digits))
} else {
dat[cols_to_round] <- lapply(dat[cols_to_round], function(x) round_half_up(x, digits = digits))
}
dat
}
}
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.