R/format.float.R

In philsf/philsfmisc: philsf's miscellaneous R functions

#' Format numbers for printing
#'
#' \code{format.float} prepares numbers for results printing.
#'
#' This function formats numbers with the given number of decimal digits.
#'   Numbers are always assumed to be \code{\link[base]{double}}.
#'   If there is a percent sign in \code{x}, it is removed prior to formatting.
#'
#' @param x Value to be formatted.
#'   Input can be a numeric or character value.
#'
#' @param digits Number of fixed digits, after decimal point
#'
#' @return Returns a character value.
#'
#' @examples
#' format.float(0.5)
#' format.float(0.672, 4)
#' format.float(1.4927, 1)
#' format.float(c(1.756, 1.823))
#' # Input is character
#' format.float("1.12543")
#' format.float(c("1.756", "1.823"))
#' # Input is percentage
#' format.float("10%", 1)
#' format.float("15 %", 1)
#'
#' # Useful for data frames
#' DF <- data.frame(num = c(1.756, 1.823), char = c("1.756", "1.823"), stringsAsFactors = FALSE)
#' transform(DF, num = format.float(num), char = format.float(char))
#'
#' @author Felipe Figueiredo
#' @importFrom stringr str_remove
#' @export format.float

format.float <- function(x, digits = 2) {
  x <- stringr::str_remove(x, "%")
  x <- suppressWarnings(as.numeric(x))
  x <- formatC(x, format = "f", digits = digits)
  x
}