diff --git a/R/f_percent.R b/R/f_percent.R index 1ee5b3e..c82e11f 100644 --- a/R/f_percent.R +++ b/R/f_percent.R @@ -1,6 +1,6 @@ #' Format Percentages #' -#' \code{f_percent} - A wraf_percenter for \code{\link[numform]{f_num}} that formats +#' \code{f_percent} - A wrapper for \code{\link[numform]{f_num}} that formats #' percent values as labeled percentages. #' #' @param x A vector of proportions. @@ -90,7 +90,11 @@ f_prop2percent <- function(x, digits = getOption("numformdigits"), less.than.rep #' @rdname f_percent ff_prop2percent <- functionize(f_prop2percent) - +#' Format Percentages +#' +#' \code{f_pp} - A wrapper for \code{\link[numform]{f_prop2percent}} that requires +#' less typing and has \code{digits} set to \code{0} by default. +#' #' @export #' @include utils.R #' @rdname f_percent diff --git a/man/f_percent.Rd b/man/f_percent.Rd index 50aa9ec..10aa79b 100644 --- a/man/f_percent.Rd +++ b/man/f_percent.Rd @@ -43,11 +43,14 @@ be \code{"<.01\%"}.} Returns a string of publication ready digits. } \description{ -\code{f_percent} - A wraf_percenter for \code{\link[numform]{f_num}} that formats +\code{f_percent} - A wrapper for \code{\link[numform]{f_num}} that formats percent values as labeled percentages. \code{f_prop2percent} - A wrapper for \code{\link[numform]{f_num}} that formats proportions as labeled percentages. + +\code{f_pp} - A wrapper for \code{\link[numform]{f_prop2percent}} that requires +less typing and has \code{digits} set to \code{0} by default. } \examples{ f_percent(c(30, 33.45, .1))