R/specify_decimals.R

In HelpersMG: Tools for Environmental Analyses, Ecotoxicology and Various R Functions

#' specify_decimals format a number with specified number of decimals
#' @title Return a number as character with specified number of decimals
#' @author Marc Girondot \email{marc.girondot@@gmail.com}
#' @return A character
#' @param x The numbers to be formated
#' @param decimals Number of decimals to print
#' @param decimal.point Character to be used as decimal point
#' @description Return a number as character with specified number of decimals. 
#' If a is a matrix, it will return a matrix of the same size and the same attributes.
#' @examples
#' specify_decimal(x=pi, decimal.point=".")
#' specify_decimal(x=pi, decimals=4, decimal.point=".")
#' specify_decimal(x=c(pi, exp(1)), decimals=3, decimal.point=",")
#' specify_decimal(x=c(pi, exp(1)), decimal.point=",")
#' specify_decimal(x=c(pi*10, pi, pi/10, pi/100, pi/1000))
#' specify_decimal(x=c(pi=pi), decimal.point=".")
#' specify_decimal(x=matrix(pi*1:4, ncol=2), decimal.point=".")
#' m <- matrix(pi*1:4, ncol=2)
#' rownames(m) <- c("A", "B")
#' colnames(m) <- c("C", "D")
#' specify_decimal(x=m, decimal.point=".")
#' @export

specify_decimal <- function(x, 
                            decimals=NULL, 
                            decimal.point=".") {
  x_ini <- x
  cxa <- attributes(x_ini)
  if (is.character(x)) x <- as.numeric(x)
  if (is.null(decimals)) {
    na <- is.na(x)
    x[is.na(x)] <- 1
    og <- log10(abs(x))
    og <- ifelse(og == -Inf, 1, og)
    decimals <- ifelse(og > 0, 3, abs(floor(og))+3)
  } else {
    na <- rep(FALSE, length(x))
  }
  decimals <- rep(decimals, length(x))[1:length(x)]
  cx <- sapply(seq_along(x), FUN=function(i) formatC(x[i], digits = decimals[i], format = "f"))
  
  if (any(na)) cx[na] <- "NA"
  cx <- gsub("\\.", decimal.point, cx)
  x_ini <- as.character(x_ini)

  x_ini[] <- cx
  attributes(x_ini) <- cxa
  return(x_ini)
}