| Title: | Extract, Format, and Print Statistical Output |
|---|---|
| Description: | Provides functions that format statistical output in a way that can be inserted into R Markdown documents. This is analogous to the apa_print() functions in the 'papaja' package but prints Markdown or LaTeX syntax. |
| Authors: | Jeffrey R. Stevens [aut, cre, cph]
|
| Maintainer: | Jeffrey R. Stevens <[email protected]> |
| License: | GPL (>= 3) |
| Version: | 0.1.0 |
| Built: | 2024-11-06 09:26:51 UTC |
| Source: | CRAN |
format_bf() can input either a
BayesFactor
object or a vector of Bayes factor values. By default, this function rounds
Bayes factors greater than 1 to one decimal place and Bayes factors less
than 1 to two decimal places. Values greater than 1000 or less than 1/1000
are formatted using scientific notation. Cutoffs can be set that format the
values as greater than or less than the cutoffs (e.g., BF > 1000 or
BF < 0.001). Numbers of digits, cutoffs, italics, and label subscripts are
all customizable.
format_bf( x, digits1 = 1, digits2 = 2, cutoff = NULL, label = "BF", italics = TRUE, subscript = "10", type = "md" )format_bf( x, digits1 = 1, digits2 = 2, cutoff = NULL, label = "BF", italics = TRUE, subscript = "10", type = "md" )
x |
BayesFactor object or vector of numeric Bayes factor values |
digits1 |
Number of digits after the decimal for Bayes factors > 1 |
digits2 |
Number of digits after the decimal for Bayes factors < 1 |
cutoff |
Cutoff for using |
label |
Character string for label before Bayes factor. Default is BF.
Set |
italics |
Logical value (default = TRUE) for whether label should be italicized (BF or BF) |
subscript |
Subscript to include with BF label ( |
type |
Type of formatting ( |
A character string that includes label (by default BF~10~) and then the
Bayes factor formatted in Markdown or LaTeX. If Bayes factor is above or
below cutoff, _BF_~10~ > <cutoff> or _BF_~10~ < 1 / <cutoff> is used.
Other functions for printing statistical objects:
format_corr(),
format_stats(),
format_stats.BFBayesFactor(),
format_stats.easycorrelation(),
format_stats.htest(),
format_ttest()
# Format BFBayesfactor objects from {BayesFactor} package format_bf(BayesFactor::lmBF(mpg ~ am, data = mtcars)) # Format Bayes factors > 1 format_bf(12.4444) # Bayes factors > 1000 will use scientific notation format_bf(1244.44) # Control digits for Bayes factors > 1 with digits1 format_bf(1244.44, digits1 = 3) # Control cutoff for output format_bf(1244.44, cutoff = 10000) # Format Bayes factors < 1 format_bf(0.111) # Bayes factors < 0.001 will use scientific notation format_bf(0.0001) # Control digits for Bayes factors < 1 with digits2 format_bf(0.111, digits2 = 3) # Control cutoff for output format_bf(0.001, cutoff = 100) # Return only Bayes factor value (no label) format_bf(12.4444, label = "") # Format for LaTeX format_bf(12.4444, type = "latex")# Format BFBayesfactor objects from {BayesFactor} package format_bf(BayesFactor::lmBF(mpg ~ am, data = mtcars)) # Format Bayes factors > 1 format_bf(12.4444) # Bayes factors > 1000 will use scientific notation format_bf(1244.44) # Control digits for Bayes factors > 1 with digits1 format_bf(1244.44, digits1 = 3) # Control cutoff for output format_bf(1244.44, cutoff = 10000) # Format Bayes factors < 1 format_bf(0.111) # Bayes factors < 0.001 will use scientific notation format_bf(0.0001) # Control digits for Bayes factors < 1 with digits2 format_bf(0.111, digits2 = 3) # Control cutoff for output format_bf(0.001, cutoff = 100) # Return only Bayes factor value (no label) format_bf(12.4444, label = "") # Format for LaTeX format_bf(12.4444, type = "latex")
Format character strings with italics and type
format_chr(x, italics = TRUE, type = "md")format_chr(x, italics = TRUE, type = "md")
x |
Character string |
italics |
Logical value (default = TRUE) for whether text should be italicized |
type |
Type of formatting ( |
A character string that has either Markdown or LaTeX formatting for italics or not.
format_chr("Hello world!") # Format in LaTeX syntax format_chr("Hello world!", type = "latex") # Remove italics format_chr("Hello world!", italics = FALSE)format_chr("Hello world!") # Format in LaTeX syntax format_chr("Hello world!", type = "latex") # Remove italics format_chr("Hello world!", italics = FALSE)
![[Superseded]](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB3aWR0aD0iMTI4IiBoZWlnaHQ9IjIwIiByb2xlPSJpbWciIGFyaWEtbGFiZWw9ImxpZmVjeWNsZTogc3VwZXJzZWRlZCI+CiAgICA8dGl0bGU+bGlmZWN5Y2xlOiBzdXBlcnNlZGVkPC90aXRsZT4KICAgIDxsaW5lYXJHcmFkaWVudCBpZD0icyIgeDI9IjAiIHkyPSIxMDAlIj4KICAgICAgICA8c3RvcCBvZmZzZXQ9IjAiIHN0b3AtY29sb3I9IiNiYmIiIHN0b3Atb3BhY2l0eT0iLjEiIC8+CiAgICAgICAgPHN0b3Agb2Zmc2V0PSIxIiBzdG9wLW9wYWNpdHk9Ii4xIiAvPgogICAgPC9saW5lYXJHcmFkaWVudD4KICAgIDxjbGlwUGF0aCBpZD0iciI+CiAgICAgICAgPHJlY3Qgd2lkdGg9IjEyOCIgaGVpZ2h0PSIyMCIgcng9IjMiIGZpbGw9IiNmZmYiIC8+CiAgICA8L2NsaXBQYXRoPgogICAgPGcgY2xpcC1wYXRoPSJ1cmwoI3IpIj4KICAgICAgICA8cmVjdCB3aWR0aD0iNTUiIGhlaWdodD0iMjAiIGZpbGw9IiM1NTUiIC8+CiAgICAgICAgPHJlY3QgeD0iNTUiIHdpZHRoPSI3MyIgaGVpZ2h0PSIyMCIgZmlsbD0iIzAwN2VjNiIgLz4KICAgICAgICA8cmVjdCB3aWR0aD0iMTI4IiBoZWlnaHQ9IjIwIiBmaWxsPSJ1cmwoI3MpIiAvPgogICAgPC9nPgogICAgPGcgZmlsbD0iI2ZmZiIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZm9udC1mYW1pbHk9IlZlcmRhbmEsR2VuZXZhLERlamFWdSBTYW5zLHNhbnMtc2VyaWYiIHRleHQtcmVuZGVyaW5nPSJnZW9tZXRyaWNQcmVjaXNpb24iIGZvbnQtc2l6ZT0iMTEwIj4KICAgICAgICA8dGV4dCBhcmlhLWhpZGRlbj0idHJ1ZSIgeD0iMjg1IiB5PSIxNTAiIGZpbGw9IiMwMTAxMDEiIGZpbGwtb3BhY2l0eT0iLjMiIHRyYW5zZm9ybT0ic2NhbGUoLjEpIiB0ZXh0TGVuZ3RoPSI0NTAiPmxpZmVjeWNsZTwvdGV4dD4KICAgICAgICA8dGV4dCB4PSIyODUiIHk9IjE0MCIgdHJhbnNmb3JtPSJzY2FsZSguMSkiIGZpbGw9IiNmZmYiIHRleHRMZW5ndGg9IjQ1MCI+bGlmZWN5Y2xlPC90ZXh0PgogICAgICAgIDx0ZXh0IGFyaWEtaGlkZGVuPSJ0cnVlIiB4PSI5MDUiIHk9IjE1MCIgZmlsbD0iIzAxMDEwMSIgZmlsbC1vcGFjaXR5PSIuMyIgdHJhbnNmb3JtPSJzY2FsZSguMSkiIHRleHRMZW5ndGg9IjYzMCI+c3VwZXJzZWRlZDwvdGV4dD4KICAgICAgICA8dGV4dCB4PSI5MDUiIHk9IjE0MCIgdHJhbnNmb3JtPSJzY2FsZSguMSkiIGZpbGw9IiNmZmYiIHRleHRMZW5ndGg9IjYzMCI+c3VwZXJzZWRlZDwvdGV4dD4KICAgIDwvZz4KPC9zdmc+Cg==)
With format_corr() you can format correlation statistics generated from
cor.test() output.
This is now an internal function superceded by format_stats(), which we
recommend using instead.
format_corr(x, digits, pdigits, pzero, full, italics, type, ...)format_corr(x, digits, pdigits, pzero, full, italics, type, ...)
x |
An |
digits |
Number of digits after the decimal for means, confidence intervals, and test statistics |
pdigits |
Number of digits after the decimal for p-values, ranging between 1-5 (also controls cutoff for small p-values) |
pzero |
Logical value (default = FALSE) for whether to include leading zero for p-values |
full |
Logical value (default = TRUE) for whether to include means and confidence intervals or just test statistic and p-value |
italics |
Logical value (default = TRUE) for whether p label should be italicized |
type |
Type of formatting ("md" = markdown, "latex" = LaTeX) |
... |
Additional arguments passed to methods. |
A character string of statistical information formatted in Markdown or LaTeX.
Other functions for printing statistical objects:
format_bf(),
format_stats(),
format_stats.BFBayesFactor(),
format_stats.easycorrelation(),
format_stats.htest(),
format_ttest()
# format_stats(cor.test(mtcars$mpg, mtcars$cyl))# format_stats(cor.test(mtcars$mpg, mtcars$cyl))
Format numbers
format_num(x, digits = 1, pzero = TRUE)format_num(x, digits = 1, pzero = TRUE)
x |
Number |
digits |
Number of digits after the decimal |
pzero |
Logical value (default = TRUE) for whether to include leading zero numbers less than 1 |
A character string formatting the number with specified number of digits after the decimal.
format_num(pi, digits = 2) format_num(pi, digits = 4)format_num(pi, digits = 2) format_num(pi, digits = 4)
format_p() inputs numeric vectors of p-values. Cutoffs can be set that
format the values as less than the cutoffs (e.g., p < 0.001). The default
output is APA formatted, but numbers of digits, cutoffs, leading zeros, and
italics are all customizable.
format_p( x, digits = 3, pzero = FALSE, label = "p", italics = TRUE, type = "md" )format_p( x, digits = 3, pzero = FALSE, label = "p", italics = TRUE, type = "md" )
x |
Number representing p-value |
digits |
Number of digits after the decimal for p-values, ranging between 1-5 (also controls cutoff for small p-values) |
pzero |
Logical value (default = FALSE) for whether to include leading zero for p-values |
label |
Character string for label before p value. Default is p.
Set |
italics |
Logical value (default = TRUE) for whether label should be italicized (p) |
type |
Type of formatting ("md" = markdown, "latex" = LaTeX) |
A character string that includes p and then the p-value formatted in
Markdown or LaTeX. If p-value is below digits cutoff, p < cutoff is
used.
# Format p-value format_p(0.001) # Format p-value vector format_p(c(0.001, 0.01)) # Round digits for p-values greater than cutoff format_p(0.111, digits = 2) # Default cutoff is p < 0.001 format_p(0.0001) # Set cutoff with digits format_p(0.0001, digits = 2) # Include leading zero format_p(0.001, pzero = TRUE) # Return only Bayes factor value (no label) format_p(0.001, label = "") # Format for LaTeX format_p(0.001, type = "latex")# Format p-value format_p(0.001) # Format p-value vector format_p(c(0.001, 0.01)) # Round digits for p-values greater than cutoff format_p(0.111, digits = 2) # Default cutoff is p < 0.001 format_p(0.0001) # Set cutoff with digits format_p(0.0001, digits = 2) # Include leading zero format_p(0.001, pzero = TRUE) # Return only Bayes factor value (no label) format_p(0.001, label = "") # Format for LaTeX format_p(0.001, type = "latex")
Format numbers in scientific notation
format_scientific(x, digits = 1, type = "md")format_scientific(x, digits = 1, type = "md")
x |
Number |
digits |
Number of digits after the decimal |
type |
Type of formatting ("md" = markdown, "latex" = LaTeX) |
A character string of a number in scientific notation formatted in Markdown or LaTeX.
format_scientific(1111) # Control number of digits after decimal with digits format_scientific(1111, digits = 3)format_scientific(1111) # Control number of digits after decimal with digits format_scientific(1111, digits = 3)
A generic function that takes objects from various statistical methods to create formatted character strings to insert into R Markdown or Quarto documents. Currently, the generic function works with the following objects:
htest objects of correlations, t-tests, and Wilcoxon tests
correlations from the {correlation} package.
Bayes factors from the {BayesFactor} package. The function invokes specific methods that depend on the class of the first argument.
format_stats(x, ...)format_stats(x, ...)
x |
Statistical object. |
... |
Additional arguments passed to methods. For method-specific
arguments, see |
A character string of statistical information formatted in Markdown or LaTeX.
Other functions for printing statistical objects:
format_bf(),
format_corr(),
format_stats.BFBayesFactor(),
format_stats.easycorrelation(),
format_stats.htest(),
format_ttest()
# Format cor.test() object format_stats(cor.test(mtcars$mpg, mtcars$cyl)) # Format correlation::correlation() object format_stats(correlation::correlation(data = mtcars, select = "mpg", select2 = "cyl")) # Format t.test() object format_stats(t.test(mtcars$vs, mtcars$am)) # Format BFBayesFactor object from {BayesFactor} package format_stats(BayesFactor::ttestBF(mtcars$vs, mtcars$am))# Format cor.test() object format_stats(cor.test(mtcars$mpg, mtcars$cyl)) # Format correlation::correlation() object format_stats(correlation::correlation(data = mtcars, select = "mpg", select2 = "cyl")) # Format t.test() object format_stats(t.test(mtcars$vs, mtcars$am)) # Format BFBayesFactor object from {BayesFactor} package format_stats(BayesFactor::ttestBF(mtcars$vs, mtcars$am))
This method formats Bayes factors from the {BayesFactor} package. By default, this function rounds Bayes factors greater than 1 to one decimal place and Bayes factors less than 1 to two decimal places. Values greater than 1000 or less than 1/1000 are formatted using scientific notation. Cutoffs can be set that format the values as greater than or less than the cutoffs (e.g., BF > 1000 or BF < 0.001). Numbers of digits, cutoffs, italics, and label subscripts are all customizable.
## S3 method for class 'BFBayesFactor' format_stats( x, digits1 = 1, digits2 = 2, cutoff = NULL, label = "BF", italics = TRUE, subscript = "10", type = "md", ... )## S3 method for class 'BFBayesFactor' format_stats( x, digits1 = 1, digits2 = 2, cutoff = NULL, label = "BF", italics = TRUE, subscript = "10", type = "md", ... )
x |
BayesFactor object or vector of numeric Bayes factor values |
digits1 |
Number of digits after the decimal for Bayes factors > 1 |
digits2 |
Number of digits after the decimal for Bayes factors < 1 |
cutoff |
Cutoff for using |
label |
Character string for label before Bayes factor. Default is BF.
Set |
italics |
Logical value (default = TRUE) for whether label should be italicized (BF or BF) |
subscript |
Subscript to include with BF label ( |
type |
Type of formatting ( |
... |
Additional arguments passed to methods. |
A character string of statistical information formatted in Markdown or LaTeX.
Other functions for printing statistical objects:
format_bf(),
format_corr(),
format_stats(),
format_stats.easycorrelation(),
format_stats.htest(),
format_ttest()
# Prepare statistical object test_bf <- BayesFactor::ttestBF(mtcars$vs, mtcars$am) # Format Bayes factor format_stats(test_bf) # Control cutoff for output format_stats(test_bf, cutoff = 3) # Change digits, remove italics and subscript format_stats(test_bf, digits2 = 1, italics = FALSE, subscript = "") # Return only Bayes factor value (no label) format_stats(test_bf, label = "") # Format for LaTeX format_stats(test_bf, type = "latex")# Prepare statistical object test_bf <- BayesFactor::ttestBF(mtcars$vs, mtcars$am) # Format Bayes factor format_stats(test_bf) # Control cutoff for output format_stats(test_bf, cutoff = 3) # Change digits, remove italics and subscript format_stats(test_bf, digits2 = 1, italics = FALSE, subscript = "") # Return only Bayes factor value (no label) format_stats(test_bf, label = "") # Format for LaTeX format_stats(test_bf, type = "latex")
This functions formats correlation statistics generated from the
{correlation} package.
This detects whether the object is from a Pearson, Spearman, or Kendall
correlation and reports the appropriate correlation label
(r, , ). The default output is APA formatted, but
numbers of digits, leading zeros, the presence of confidence intervals,
and italics are all customizable.
## S3 method for class 'easycorrelation' format_stats( x, digits = 2, pdigits = 3, pzero = FALSE, full = TRUE, italics = TRUE, type = "md", ... )## S3 method for class 'easycorrelation' format_stats( x, digits = 2, pdigits = 3, pzero = FALSE, full = TRUE, italics = TRUE, type = "md", ... )
x |
An |
digits |
Number of digits after the decimal for means, confidence intervals, and test statistics |
pdigits |
Number of digits after the decimal for p-values, ranging between 1-5 (also controls cutoff for small p-values) |
pzero |
Logical value (default = FALSE) for whether to include leading zero for p-values |
full |
Logical value (default = TRUE) for whether to include means and confidence intervals or just test statistic and p-value |
italics |
Logical value (default = TRUE) for whether p label should be italicized |
type |
Type of formatting ("md" = markdown, "latex" = LaTeX) |
... |
Additional arguments passed to methods. |
A character string of statistical information formatted in Markdown or LaTeX.
Other functions for printing statistical objects:
format_bf(),
format_corr(),
format_stats(),
format_stats.BFBayesFactor(),
format_stats.htest(),
format_ttest()
# Prepare statistical objects test_corr <- correlation::correlation(mtcars, select = "mpg", select2 = "disp") test_corr2 <- correlation::correlation(mtcars, select = "mpg", select2 = "disp", method = "kendall") # Format correlation format_stats(test_corr) # Remove confidence intervals and italics format_stats(test_corr, full = FALSE, italics = FALSE) # Change digits and add leading zero to p-value format_stats(test_corr, digits = 3, pdigits = 4, pzero = TRUE) # Format Kendall's tau for LaTeX format_stats(test_corr2, type = "latex")# Prepare statistical objects test_corr <- correlation::correlation(mtcars, select = "mpg", select2 = "disp") test_corr2 <- correlation::correlation(mtcars, select = "mpg", select2 = "disp", method = "kendall") # Format correlation format_stats(test_corr) # Remove confidence intervals and italics format_stats(test_corr, full = FALSE, italics = FALSE) # Change digits and add leading zero to p-value format_stats(test_corr, digits = 3, pdigits = 4, pzero = TRUE) # Format Kendall's tau for LaTeX format_stats(test_corr2, type = "latex")
This method formats hypothesis test statistics from the class htest.
Currently, this includes correlations from cor.test() and t-tests and
Wilcoxon tests from t.test() and wilcox.test(). For correlations, the
function detects whether the object is from a Pearson,
Spearman, or Kendall correlation and reports the appropriate correlation
label (r, , ). The default output is APA formatted, but
this function allows control over numbers of
digits, leading zeros, the presence of means and confidence intervals,
italics, degrees of freedom, and mean labels, and output format of
Markdown or LaTeX.
## S3 method for class 'htest' format_stats( x, digits = NULL, pdigits = 3, pzero = FALSE, full = TRUE, italics = TRUE, dfs = "par", mean = "abbr", type = "md", ... )## S3 method for class 'htest' format_stats( x, digits = NULL, pdigits = 3, pzero = FALSE, full = TRUE, italics = TRUE, dfs = "par", mean = "abbr", type = "md", ... )
x |
An |
digits |
Number of digits after the decimal for means, confidence intervals, and test statistics |
pdigits |
Number of digits after the decimal for p-values, ranging between 1-5 (also controls cutoff for small p-values) |
pzero |
Logical value (default = FALSE) for whether to include leading zero for p-values |
full |
Logical value (default = TRUE) for whether to include means and confidence intervals or just test statistic and p-value |
italics |
Logical value (default = TRUE) for whether p label should be italicized |
dfs |
Formatting for degrees of freedom ("par" = parenthetical, "sub" = subscript, "none" = do not print degrees of freedom) |
mean |
Formatting for mean label ("abbr" = M, "word" = Mean) |
type |
Type of formatting ("md" = markdown, "latex" = LaTeX) |
... |
Additional arguments passed to methods. |
A character string of statistical information formatted in Markdown or LaTeX.
Other functions for printing statistical objects:
format_bf(),
format_corr(),
format_stats(),
format_stats.BFBayesFactor(),
format_stats.easycorrelation(),
format_ttest()
# Prepare statistical objects test_corr <- cor.test(mtcars$mpg, mtcars$cyl) test_corr2 <- cor.test(mtcars$mpg, mtcars$cyl, method = "kendall") test_ttest <- t.test(mtcars$vs, mtcars$am) test_ttest2 <- wilcox.test(mtcars$vs, mtcars$am) # Format correlation format_stats(test_corr) # Remove confidence intervals and italics format_stats(test_corr, full = FALSE, italics = FALSE) # Change digits and add leading zero to p-value format_stats(test_corr, digits = 3, pdigits = 4, pzero = TRUE) # Format Kendall's tau format_stats(test_corr2) # Format t-test format_stats(test_ttest) # Remove mean and confidence interval format_stats(test_ttest, full = FALSE) # Remove degrees of freedom and spell out "Mean" format_stats(test_ttest, dfs = "none", mean = "word") # Format for LaTeX format_stats(test_ttest2, type = "latex")# Prepare statistical objects test_corr <- cor.test(mtcars$mpg, mtcars$cyl) test_corr2 <- cor.test(mtcars$mpg, mtcars$cyl, method = "kendall") test_ttest <- t.test(mtcars$vs, mtcars$am) test_ttest2 <- wilcox.test(mtcars$vs, mtcars$am) # Format correlation format_stats(test_corr) # Remove confidence intervals and italics format_stats(test_corr, full = FALSE, italics = FALSE) # Change digits and add leading zero to p-value format_stats(test_corr, digits = 3, pdigits = 4, pzero = TRUE) # Format Kendall's tau format_stats(test_corr2) # Format t-test format_stats(test_ttest) # Remove mean and confidence interval format_stats(test_ttest, full = FALSE) # Remove degrees of freedom and spell out "Mean" format_stats(test_ttest, dfs = "none", mean = "word") # Format for LaTeX format_stats(test_ttest2, type = "latex")
Format subscript text
format_sub(subscript = NULL, type = "md")format_sub(subscript = NULL, type = "md")
subscript |
Character string or NULL |
type |
Type of formatting ( |
A character string that is formatted as subscript for either Markdown or LaTeX.
format_sub("Hello world!") # Format in LaTeX syntax format_sub("Hello world!", type = "latex")format_sub("Hello world!") # Format in LaTeX syntax format_sub("Hello world!", type = "latex")
format_summary() is a general function that allows you to either
automatically calculate mean/median and a measure of error from a data vector
or specify already calculated a mean/median and either an error interval or
error limits. Error measures include confidence intervals, standard
deviation, and standard error of the mean. Each of those has a specific
function that formats means and those error measures using APA (7th edition)
style. So format_meanci(), format_meansd(), format_meanse(), and
format_medianiqr() are wrappers around format_summary() for specific
error measures with a default style. To just format the mean or median with
no error, use format_mean() or format_median(). All measures ignore NAs.
format_summary( x = NULL, tendency = "mean", error = "ci", values = NULL, digits = 1, tendlabel = "abbr", italics = TRUE, subscript = NULL, units = NULL, display = "limits", cilevel = 0.95, errorlabel = TRUE, type = "md" ) format_mean( x = NULL, tendency = "mean", values = NULL, digits = 1, tendlabel = "abbr", italics = TRUE, subscript = NULL, units = NULL, display = "none", type = "md" ) format_meanci( x = NULL, tendency = "mean", error = "ci", values = NULL, digits = 1, tendlabel = "abbr", italics = TRUE, subscript = NULL, units = NULL, display = "limits", cilevel = 0.95, errorlabel = TRUE, type = "md" ) format_meanse( x = NULL, tendency = "mean", error = "se", values = NULL, digits = 1, tendlabel = "abbr", italics = TRUE, subscript = NULL, units = NULL, display = "par", errorlabel = TRUE, type = "md" ) format_meansd( x = NULL, tendency = "mean", error = "sd", values = NULL, digits = 1, tendlabel = "abbr", italics = TRUE, subscript = NULL, units = NULL, display = "par", errorlabel = TRUE, type = "md" ) format_median( x = NULL, tendency = "median", values = NULL, digits = 1, tendlabel = "abbr", italics = TRUE, subscript = NULL, units = NULL, display = "none", type = "md" ) format_medianiqr( x = NULL, tendency = "median", error = "iqr", values = NULL, digits = 1, tendlabel = "abbr", italics = TRUE, subscript = NULL, units = NULL, display = "par", errorlabel = TRUE, type = "md" )format_summary( x = NULL, tendency = "mean", error = "ci", values = NULL, digits = 1, tendlabel = "abbr", italics = TRUE, subscript = NULL, units = NULL, display = "limits", cilevel = 0.95, errorlabel = TRUE, type = "md" ) format_mean( x = NULL, tendency = "mean", values = NULL, digits = 1, tendlabel = "abbr", italics = TRUE, subscript = NULL, units = NULL, display = "none", type = "md" ) format_meanci( x = NULL, tendency = "mean", error = "ci", values = NULL, digits = 1, tendlabel = "abbr", italics = TRUE, subscript = NULL, units = NULL, display = "limits", cilevel = 0.95, errorlabel = TRUE, type = "md" ) format_meanse( x = NULL, tendency = "mean", error = "se", values = NULL, digits = 1, tendlabel = "abbr", italics = TRUE, subscript = NULL, units = NULL, display = "par", errorlabel = TRUE, type = "md" ) format_meansd( x = NULL, tendency = "mean", error = "sd", values = NULL, digits = 1, tendlabel = "abbr", italics = TRUE, subscript = NULL, units = NULL, display = "par", errorlabel = TRUE, type = "md" ) format_median( x = NULL, tendency = "median", values = NULL, digits = 1, tendlabel = "abbr", italics = TRUE, subscript = NULL, units = NULL, display = "none", type = "md" ) format_medianiqr( x = NULL, tendency = "median", error = "iqr", values = NULL, digits = 1, tendlabel = "abbr", italics = TRUE, subscript = NULL, units = NULL, display = "par", errorlabel = TRUE, type = "md" )
x |
Numeric vector of data to calculate mean and error |
tendency |
Character vector specifying measure of central tendency ("mean" = mean, "median" = median) |
error |
Character vector specifying error type ("ci" = confidence interval, "se" = standard error of the mean, "sd" = standard deviation, "iqr" = interquartile range) |
values |
Numeric vector of mean and interval or mean and lower and upper limits |
digits |
Number of digits after the decimal for means and error |
tendlabel |
Formatting for tendency label ("abbr" = M, "word" = Mean, "none" = no label) |
italics |
Logical value (default = TRUE) for whether mean label should be italicized |
subscript |
Character string to include as subscript with mean label |
units |
Character string that gives units to include after mean value |
display |
Character vector specifying how to display error ("limits" = [lower limit, upper limit], "pm" = ±interval, "par" = (interval), "none" = do not display error) |
cilevel |
Numeric scalar from 0-1 defining confidence level (defaults to 0.95) |
errorlabel |
Logical value (default = TRUE) for whether error label (e.g., 95% CI) should be included |
type |
Type of formatting ("md" = markdown, "latex" = LaTeX) |
A character string of mean and error formatted in Markdown or LaTeX.
To return only the mean (no error), set display = "none".
# Print mean and 95% confidence limits for fuel efficiency format_meanci(mtcars$mpg) # Print mean and standard deviation format_meansd(mtcars$mpg) # Print mean and standard error of the mean format_meanse(mtcars$mpg) # Print mean format_mean(mtcars$mpg) # Print mean and 95% confidence limits with no label for "95% CI" format_meanci(mtcars$mpg, errorlabel = FALSE) # Print mean and standard error of the mean as plus/minus interval format_meanse(mtcars$mpg, error = "se", display = "pm") # Print mean and 90% confidence limits with units format_meanci(mtcars$mpg, units = "cm", cilevel = 0.9) # Print three-digit mean with subscript in LaTeX format_summary(mtcars$mpg, digits = 3, subscript = "control", display = "none", type = "latex")# Print mean and 95% confidence limits for fuel efficiency format_meanci(mtcars$mpg) # Print mean and standard deviation format_meansd(mtcars$mpg) # Print mean and standard error of the mean format_meanse(mtcars$mpg) # Print mean format_mean(mtcars$mpg) # Print mean and 95% confidence limits with no label for "95% CI" format_meanci(mtcars$mpg, errorlabel = FALSE) # Print mean and standard error of the mean as plus/minus interval format_meanse(mtcars$mpg, error = "se", display = "pm") # Print mean and 90% confidence limits with units format_meanci(mtcars$mpg, units = "cm", cilevel = 0.9) # Print three-digit mean with subscript in LaTeX format_summary(mtcars$mpg, digits = 3, subscript = "control", display = "none", type = "latex")
With format_ttest() you can format t-tests generated from t.test() and
wilcox.test() output.
This is now an internal function superceded by format_stats(), which we
recommend using instead.
format_ttest(x, digits, pdigits, pzero, full, italics, dfs, mean, type)format_ttest(x, digits, pdigits, pzero, full, italics, dfs, mean, type)
x |
An |
digits |
Number of digits after the decimal for means, confidence intervals, and test statistics |
pdigits |
Number of digits after the decimal for p-values, ranging between 1-5 (also controls cutoff for small p-values) |
pzero |
Logical value (default = FALSE) for whether to include leading zero for p-values |
full |
Logical value (default = TRUE) for whether to include means and confidence intervals or just test statistic and p-value |
italics |
Logical value (default = TRUE) for whether p label should be italicized |
dfs |
Formatting for degrees of freedom ("par" = parenthetical, "sub" = subscript, "none" = do not print degrees of freedom) |
mean |
Formatting for mean label ("abbr" = M, "word" = Mean) |
type |
Type of formatting ("md" = markdown, "latex" = LaTeX) |
A character string of statistical information formatted in Markdown or LaTeX.
Other functions for printing statistical objects:
format_bf(),
format_corr(),
format_stats(),
format_stats.BFBayesFactor(),
format_stats.easycorrelation(),
format_stats.htest()
format_stats(t.test(formula = mtcars$mpg ~ mtcars$vs))format_stats(t.test(formula = mtcars$mpg ~ mtcars$vs))