|
11 | 11 | #' @param select Determines which columns and and which layout columns are
|
12 | 12 | #' printed. There are three options for this argument:
|
13 | 13 | #'
|
14 |
| -#' 1. Selecting columns by name or index |
| 14 | +#' * **Selecting columns by name or index** |
15 | 15 | #'
|
16 | 16 | #' `select` can be a character vector (or numeric index) of column names that
|
17 | 17 | #' should be printed, where columns are extracted from the data frame returned
|
|
22 | 22 | #' p-values, while `select = "short"` prints coefficients, standard errors and
|
23 | 23 | #' p-values.
|
24 | 24 | #'
|
25 |
| -#' 2. A string expression with layout pattern |
| 25 | +#' * **A string expression with layout pattern** |
26 | 26 | #'
|
27 | 27 | #' `select` is a string with "tokens" enclosed in braces. These tokens will be
|
28 | 28 | #' replaced by their associated columns, where the selected columns will be
|
|
37 | 37 | #' If `format = "html"`, a `<br>` inserts a line break inside a cell. See
|
38 | 38 | #' 'Examples'.
|
39 | 39 | #'
|
40 |
| -#' 3. A string indicating a pre-defined layout |
| 40 | +#' *. **A string indicating a pre-defined layout** |
41 | 41 | #'
|
42 | 42 | #' `select` can be one of the following string values, to create one of the
|
43 | 43 | #' following pre-defined column layouts:
|
44 | 44 | #'
|
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}"`. |
57 | 57 | #'
|
58 | 58 | #' For `model_parameters()`, glue-like syntax is still experimental in the
|
59 | 59 | #' case of more complex models (like mixed models) and may not return expected
|
|
0 commit comments