Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
strengejacke committed Oct 25, 2024
1 parent a35afea commit 22ce475
Show file tree
Hide file tree
Showing 5 changed files with 91 additions and 103 deletions.
30 changes: 15 additions & 15 deletions R/print.parameters_model.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
#' @param select Determines which columns and and which layout columns are
#' printed. There are three options for this argument:
#'
#' 1. Selecting columns by name or index
#' * **Selecting columns by name or index**
#'
#' `select` can be a character vector (or numeric index) of column names that
#' should be printed, where columns are extracted from the data frame returned
Expand All @@ -22,7 +22,7 @@
#' p-values, while `select = "short"` prints coefficients, standard errors and
#' p-values.
#'
#' 2. A string expression with layout pattern
#' * **A string expression with layout pattern**
#'
#' `select` is a string with "tokens" enclosed in braces. These tokens will be
#' replaced by their associated columns, where the selected columns will be
Expand All @@ -37,23 +37,23 @@
#' If `format = "html"`, a `<br>` inserts a line break inside a cell. See
#' 'Examples'.
#'
#' 3. A string indicating a pre-defined layout
#' *. **A string indicating a pre-defined layout**
#'
#' `select` can be one of the following string values, to create one of the
#' following pre-defined column layouts:
#'
#' - `"ci"`: Estimates and confidence intervals, no asterisks for p-values.
#' This is equivalent to `select = "{estimate} ({ci})"`.
#' - `"se"`: Estimates and standard errors, no asterisks for p-values. This is
#' equivalent to `select = "{estimate} ({se})"`.
#' - `"ci_p"`: Estimates, confidence intervals and asterisks for p-values. This
#' is equivalent to `select = "{estimate}{stars} ({ci})"`.
#' - `"se_p"`: Estimates, standard errors and asterisks for p-values. This is
#' equivalent to `select = "{estimate}{stars} ({se})"`..
#' - `"ci_p2"`: Estimates, confidence intervals and numeric p-values, in two
#' columns. This is equivalent to `select = "{estimate} ({ci})|{p}"`.
#' - `"se_p2"`: Estimate, standard errors and numeric p-values, in two columns.
#' This is equivalent to `select = "{estimate} ({se})|{p}"`.
#' - `"ci"`: Estimates and confidence intervals, no asterisks for p-values.
#' This is equivalent to `select = "{estimate} ({ci})"`.
#' - `"se"`: Estimates and standard errors, no asterisks for p-values. This is
#' equivalent to `select = "{estimate} ({se})"`.
#' - `"ci_p"`: Estimates, confidence intervals and asterisks for p-values. This
#' is equivalent to `select = "{estimate}{stars} ({ci})"`.
#' - `"se_p"`: Estimates, standard errors and asterisks for p-values. This is
#' equivalent to `select = "{estimate}{stars} ({se})"`..
#' - `"ci_p2"`: Estimates, confidence intervals and numeric p-values, in two
#' columns. This is equivalent to `select = "{estimate} ({ci})|{p}"`.
#' - `"se_p2"`: Estimate, standard errors and numeric p-values, in two columns.
#' This is equivalent to `select = "{estimate} ({se})|{p}"`.
#'
#' For `model_parameters()`, glue-like syntax is still experimental in the
#' case of more complex models (like mixed models) and may not return expected
Expand Down
41 changes: 19 additions & 22 deletions man/compare_parameters.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

41 changes: 19 additions & 22 deletions man/display.parameters_model.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

41 changes: 19 additions & 22 deletions man/print.compare_parameters.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

41 changes: 19 additions & 22 deletions man/print.parameters_model.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 22ce475

Please sign in to comment.