Nothing
#' APA Format
#'
#' A function that formats decimals and leading zeroes
#' for creating reports in scientific style.
#'
#' @param value A set of numeric values, either a single number, vector, or set of columns.
#' @param decimals The number of decimal points desired in the output.
#' @param leading Logical value: \code{TRUE} for leading zeroes on decimals
#' and \code{FALSE} for no leading zeroes on decimals. The default is \code{TRUE}.
#' @keywords APA, decimals, formatting
#' @details
#' This function creates "pretty" character vectors from numeric variables
#' for printing as part of a report. The value can take a single number,
#' matrix, vector, or multiple columns from a data frame, as long as they are
#' numeric. The values will be coerced into numeric if they are characters or
#' logical values, but this process may result in an error if values are
#' truly alphabetical.
#' @examples
#' apa(value = 0.54674, decimals = 3, leading = TRUE)
#' @export
apa <- function(value, decimals = 3, leading = TRUE) {
if (missing(value)) {
stop("Be sure to include the numeric values you wish to format.")
}
if (!is.numeric(value)){
stop("The values you provided are not numeric.")
}
if (leading == T) {
formnumber <- format(round(as.numeric(value), decimals), digits = decimals, nsmall = decimals)
}
if (leading == F) {
formnumber <- sub("^(-?)0.", "\\1.", sprintf(paste("%.", decimals, "f", sep = ""), as.numeric(value)))
}
return(formnumber)
}
#' @rdname apa
#' @export
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.