From 5b3b42aafdf60253d669d12cb88941c374e1508e Mon Sep 17 00:00:00 2001
From: Vincent Arel-Bundock <vincent.arel-bundock@umontreal.ca>
Date: Fri, 26 Jul 2024 06:55:09 -0400
Subject: [PATCH] docs

---
 R/modelsummary.R                      | 2 +-
 man/datasummary_balance.Rd            | 2 +-
 man/datasummary_correlation.Rd        | 2 +-
 man/datasummary_correlation_format.Rd | 2 +-
 man/modelsummary.Rd                   | 2 +-
 man/msummary.Rd                       | 2 +-
 6 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/R/modelsummary.R b/R/modelsummary.R
index ea23e04e..7139a920 100644
--- a/R/modelsummary.R
+++ b/R/modelsummary.R
@@ -62,7 +62,7 @@ globalVariables(c('.', 'term', 'part', 'estimate', 'conf.high', 'conf.low',
 #' * Note on LaTeX output: To ensure proper typography, all numeric entries are enclosed in the `\num{}` command, which requires the `siunitx` package to be loaded in the LaTeX preamble. This behavior can be altered with global options. See the 'Details' section.
 #' @param stars to indicate statistical significance
 #' * FALSE (default): no significance stars.
-#' * TRUE: +=.1, *=.05, **=.01, ***=0.001
+#' * TRUE: `c("+" = .1, "*" = .05, "**" = .01, "***" = 0.001)`
 #' * Named numeric vector for custom stars such as `c('*' = .1, '+' = .05)`
 #' * Note: a legend will not be inserted at the bottom of the table when the `estimate` or `statistic` arguments use "glue strings" with `{stars}`.
 #' @param statistic vector of strings or `glue` strings which select uncertainty statistics to report vertically below the estimate. NULL omits all uncertainty statistics.
diff --git a/man/datasummary_balance.Rd b/man/datasummary_balance.Rd
index d921c6fc..6015ce77 100644
--- a/man/datasummary_balance.Rd
+++ b/man/datasummary_balance.Rd
@@ -79,7 +79,7 @@ the table (e.g., \code{align = "lcc"}).  Valid characters: l, c, r, d.
 \item{stars}{to indicate statistical significance
 \itemize{
 \item FALSE (default): no significance stars.
-\item TRUE: +=.1, *=.05, **=.01, ***=0.001
+\item TRUE: \code{c("+" = .1, "*" = .05, "**" = .01, "***" = 0.001)}
 \item Named numeric vector for custom stars such as \code{c('*' = .1, '+' = .05)}
 \item Note: a legend will not be inserted at the bottom of the table when the \code{estimate} or \code{statistic} arguments use "glue strings" with \code{{stars}}.
 }}
diff --git a/man/datasummary_correlation.Rd b/man/datasummary_correlation.Rd
index fa330715..a132929a 100644
--- a/man/datasummary_correlation.Rd
+++ b/man/datasummary_correlation.Rd
@@ -89,7 +89,7 @@ prevent the file from compiling/displaying. \code{TRUE} escapes all cells, capti
 \item{stars}{to indicate statistical significance
 \itemize{
 \item FALSE (default): no significance stars.
-\item TRUE: +=.1, *=.05, **=.01, ***=0.001
+\item TRUE: \code{c("+" = .1, "*" = .05, "**" = .01, "***" = 0.001)}
 \item Named numeric vector for custom stars such as \code{c('*' = .1, '+' = .05)}
 \item Note: a legend will not be inserted at the bottom of the table when the \code{estimate} or \code{statistic} arguments use "glue strings" with \code{{stars}}.
 }}
diff --git a/man/datasummary_correlation_format.Rd b/man/datasummary_correlation_format.Rd
index ba8322fa..5148793c 100644
--- a/man/datasummary_correlation_format.Rd
+++ b/man/datasummary_correlation_format.Rd
@@ -42,7 +42,7 @@ upper triangle are replaced by the same character (e.g., "" or ".").}
 \item{stars}{to indicate statistical significance
 \itemize{
 \item FALSE (default): no significance stars.
-\item TRUE: +=.1, *=.05, **=.01, ***=0.001
+\item TRUE: \code{c("+" = .1, "*" = .05, "**" = .01, "***" = 0.001)}
 \item Named numeric vector for custom stars such as \code{c('*' = .1, '+' = .05)}
 \item Note: a legend will not be inserted at the bottom of the table when the \code{estimate} or \code{statistic} arguments use "glue strings" with \code{{stars}}.
 }}
diff --git a/man/modelsummary.Rd b/man/modelsummary.Rd
index e3161038..afe3aca6 100644
--- a/man/modelsummary.Rd
+++ b/man/modelsummary.Rd
@@ -137,7 +137,7 @@ statistics are exponentiated, and the \code{std.error} is transformed to
 \item{stars}{to indicate statistical significance
 \itemize{
 \item FALSE (default): no significance stars.
-\item TRUE: +=.1, *=.05, **=.01, ***=0.001
+\item TRUE: \code{c("+" = .1, "*" = .05, "**" = .01, "***" = 0.001)}
 \item Named numeric vector for custom stars such as \code{c('*' = .1, '+' = .05)}
 \item Note: a legend will not be inserted at the bottom of the table when the \code{estimate} or \code{statistic} arguments use "glue strings" with \code{{stars}}.
 }}
diff --git a/man/msummary.Rd b/man/msummary.Rd
index 7b5cf893..08e4c3ff 100644
--- a/man/msummary.Rd
+++ b/man/msummary.Rd
@@ -137,7 +137,7 @@ statistics are exponentiated, and the \code{std.error} is transformed to
 \item{stars}{to indicate statistical significance
 \itemize{
 \item FALSE (default): no significance stars.
-\item TRUE: +=.1, *=.05, **=.01, ***=0.001
+\item TRUE: \code{c("+" = .1, "*" = .05, "**" = .01, "***" = 0.001)}
 \item Named numeric vector for custom stars such as \code{c('*' = .1, '+' = .05)}
 \item Note: a legend will not be inserted at the bottom of the table when the \code{estimate} or \code{statistic} arguments use "glue strings" with \code{{stars}}.
 }}