added a description of f_pp

trinker · Mar 17, 2018 · 86049f2 · 86049f2
1 parent d840cde
commit 86049f2
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git 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