Skip to content

Commit 22ce475

Browse files
committed
docs
1 parent a35afea commit 22ce475

File tree

5 files changed

+91
-103
lines changed

5 files changed

+91
-103
lines changed

R/print.parameters_model.R

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
#' @param select Determines which columns and and which layout columns are
1212
#' printed. There are three options for this argument:
1313
#'
14-
#' 1. Selecting columns by name or index
14+
#' * **Selecting columns by name or index**
1515
#'
1616
#' `select` can be a character vector (or numeric index) of column names that
1717
#' should be printed, where columns are extracted from the data frame returned
@@ -22,7 +22,7 @@
2222
#' p-values, while `select = "short"` prints coefficients, standard errors and
2323
#' p-values.
2424
#'
25-
#' 2. A string expression with layout pattern
25+
#' * **A string expression with layout pattern**
2626
#'
2727
#' `select` is a string with "tokens" enclosed in braces. These tokens will be
2828
#' replaced by their associated columns, where the selected columns will be
@@ -37,23 +37,23 @@
3737
#' If `format = "html"`, a `<br>` inserts a line break inside a cell. See
3838
#' 'Examples'.
3939
#'
40-
#' 3. A string indicating a pre-defined layout
40+
#' *. **A string indicating a pre-defined layout**
4141
#'
4242
#' `select` can be one of the following string values, to create one of the
4343
#' following pre-defined column layouts:
4444
#'
45-
#' - `"ci"`: Estimates and confidence intervals, no asterisks for p-values.
46-
#' This is equivalent to `select = "{estimate} ({ci})"`.
47-
#' - `"se"`: Estimates and standard errors, no asterisks for p-values. This is
48-
#' equivalent to `select = "{estimate} ({se})"`.
49-
#' - `"ci_p"`: Estimates, confidence intervals and asterisks for p-values. This
50-
#' is equivalent to `select = "{estimate}{stars} ({ci})"`.
51-
#' - `"se_p"`: Estimates, standard errors and asterisks for p-values. This is
52-
#' equivalent to `select = "{estimate}{stars} ({se})"`..
53-
#' - `"ci_p2"`: Estimates, confidence intervals and numeric p-values, in two
54-
#' columns. This is equivalent to `select = "{estimate} ({ci})|{p}"`.
55-
#' - `"se_p2"`: Estimate, standard errors and numeric p-values, in two columns.
56-
#' This is equivalent to `select = "{estimate} ({se})|{p}"`.
45+
#' - `"ci"`: Estimates and confidence intervals, no asterisks for p-values.
46+
#' This is equivalent to `select = "{estimate} ({ci})"`.
47+
#' - `"se"`: Estimates and standard errors, no asterisks for p-values. This is
48+
#' equivalent to `select = "{estimate} ({se})"`.
49+
#' - `"ci_p"`: Estimates, confidence intervals and asterisks for p-values. This
50+
#' is equivalent to `select = "{estimate}{stars} ({ci})"`.
51+
#' - `"se_p"`: Estimates, standard errors and asterisks for p-values. This is
52+
#' equivalent to `select = "{estimate}{stars} ({se})"`..
53+
#' - `"ci_p2"`: Estimates, confidence intervals and numeric p-values, in two
54+
#' columns. This is equivalent to `select = "{estimate} ({ci})|{p}"`.
55+
#' - `"se_p2"`: Estimate, standard errors and numeric p-values, in two columns.
56+
#' This is equivalent to `select = "{estimate} ({se})|{p}"`.
5757
#'
5858
#' For `model_parameters()`, glue-like syntax is still experimental in the
5959
#' case of more complex models (like mixed models) and may not return expected

man/compare_parameters.Rd

Lines changed: 19 additions & 22 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/display.parameters_model.Rd

Lines changed: 19 additions & 22 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/print.compare_parameters.Rd

Lines changed: 19 additions & 22 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/print.parameters_model.Rd

Lines changed: 19 additions & 22 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)