Mostly for internal use, but can be useful when users supply a function to the method argument of datasummary_correlation.

datasummary_correlation_format(
x,
fmt,
diagonal = NULL,
upper_triangle = NULL
)

## Arguments

x square numeric matrix determines how to format numeric values integer: the number of digits to keep after the period format(round(x, fmt), nsmall=fmt) character: passed to the sprintf function (e.g., '%.3f' keeps 3 digits with trailing zero). See ?sprintf function: returns a formatted character string. Note on LaTeX formatting: To ensure proper typography, all numeric entries are enclosed in the \num{} command from the siunitx LaTeX package by default. This behavior can be altered with global options. See the 'Details' section. boolean. If FALSE, leading zeros are removed character or NULL. If character, all elements of the diagonal are replaced by the same character (e.g., "1"). character or NULL. If character, all elements of the upper triangle are replaced by the same character (e.g., "" or ".").

## Examples

if (FALSE) {
library(modelsummary)

dat <- mtcars[, c("mpg", "hp", "disp")]

cor_fun <- function(x) {
out <- cor(x, method = "kendall")
datasummary_correlation_format(
out,
fmt = 2,
upper_triangle = "x",
diagonal = ".")
}

datasummary_correlation(dat, method = cor_fun)
}