R/pstars.R

In uhlitz/pstars: Display p-values with asterisk symbols

#' Convert numeric pvalues to character vector.
#'
#' \code{pstars} converts numeric pvalues to a character vector of asterisk symbols.
#'
#' @param pvalues vector of numeric pvalues to be converted
#' @return A character vector of same length as input
#' @examples
#' pstars(c(0.04, 0.005, 0.1))
pstar <- function(pvalue) {
  if(!is.numeric(pvalue)) stop("pvalues must be of class numeric")
  if(pvalue >= 0.05) result <- "n.s."
  if(pvalue < 0.05) result <- "*"
  if(pvalue < 0.01) result <- "**"
  if(pvalue < 0.001) result <- "***"
  if(pvalue < 0.0001) result <- "****"
  if(pvalue < 0.00001) result <- "*****"
  return(result)
}
#' @export
pstars <- function(pvalues) {
  sapply(pvalues, pstar)
}