R/my_percent.R

Defines functions my_percent

Documented in my_percent

#' Columnwise percentage calculation within pipe
#'
#' After counting or summarising in dplyr, generates percentages instead of
#' probabilites. It is a wrapper around round(n/sum(n)*100).
#'
#' @param n Character object.
#' @param digits Number of decimal places to display.
#'
#' @return Column with percentage.
#' @export
#'
#' @examples
#' library(dplyr)
#' mtcars %>%
#'   count(cyl) %>%
#'   mutate(p = my_percent(n))
#'
my_percent <- function(n, digits = 1) {
  round(n/sum(n)*100, digits)
}
bsurial/bernr documentation built on Nov. 7, 2022, 1:41 a.m.