R/decimals_only.R

In Alaburda/statistician: Making Easy Statistical Reports

#' Printing a specified number of decimals and ignore leading zeros
#'
#' @param x the values to be printed
#' @param decimals how many decimals are to be printed. Defaults to 2.
#' @param decimals1 Boolean - should a value of exactly 1 be converted
#'     to 1.00. Defaults to FALSE.
#'
#' @return The number in the required format
#'
#' @examples
#'
#' decimals_only(c(0.23456, 0.873, 0.3456), decimals = 3)
#'
#' @author Martin Papenberg \email{martin.papenberg@@hhu.de}
#' @export
#'

decimals_only <- function(x, decimals = 2, decimals1 = FALSE) {
  if (any(x > 1, na.rm = TRUE))
    warning("At least one number was greater than one, its leading digit was left intact.")
  return(vectorise_print(x, decimals, decimals_only_, decimals1))
}

decimals_only_ <- function(x, decimals, decimals1) {
  x_ <- abs(x)
  if (is.na(x_))
    return(NA_character_)
  if (x_ == 1 & decimals1 == FALSE)
    return(force_or_cut(x_, decimals))
  n_small <- force_decimals_(x_, decimals)
  if (round(x_, decimals) == 1)
    return(n_small)
  if (x_ >= 1) {
    ret <- n_small
  } else {
    ret <- paste0(".", strsplit(as.character(n_small), ".", TRUE)[[1]][2])
  }
  if (x < 0) ret <- paste0("-", ret)
  return(ret)
}