Skip to content

Commit

Permalink
Docs for print (#1001)
Browse files Browse the repository at this point in the history
* Docs for print

* typo

* missing comma
  • Loading branch information
strengejacke authored Jul 25, 2024
1 parent ac515ef commit 2e2ce84
Show file tree
Hide file tree
Showing 8 changed files with 27 additions and 8 deletions.
2 changes: 1 addition & 1 deletion R/format_parameters.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
#' @section Interpretation of Interaction Terms:
#' Note that the *interpretation* of interaction terms depends on many
#' characteristics of the model. The number of parameters, and overall
#' performance of the model, can differ *or not* between `a * b`
#' performance of the model, can differ *or not* between `a * b`,
#' `a : b`, and `a / b`, suggesting that sometimes interaction terms
#' give different parameterizations of the same model, but other times it gives
#' completely different models (depending on `a` or `b` being factors
Expand Down
3 changes: 2 additions & 1 deletion R/print.compare_parameters.R
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,8 @@ print.compare_parameters <- function(x,
ci_brackets = ci_brackets,
format = "text",
groups = groups,
zap_small = zap_small
zap_small = zap_small,
...
)

# if we have multiple components, we can align colum width across components here
Expand Down
6 changes: 6 additions & 0 deletions R/print.parameters_model.R
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@
#' categorical predictors. The coefficient for the reference level is always
#' `0` (except when `exponentiate = TRUE`, then the coefficient will be `1`),
#' so this is just for completeness.
#' @param ... Arguments passed down to [`format.parameters_model()`],
#' [`insight::format_table()`] and [`insight::export_table()`]
#' @inheritParams insight::format_table
#' @inheritParams compare_parameters
#' @inheritParams display.parameters_model
Expand Down Expand Up @@ -142,6 +144,10 @@
#' the default HTML engine for tables to `gt`, i.e. the _gt_ package is used to
#' create HTML tables. If set to `tt`, the _tinytable_ package is used.
#'
#' - `insight_use_symbols`: `options(insight_use_symbols = TRUE)` will try to
#' print unicode-chars for symbols as column names, wherever possible (e.g.,
#' \ifelse{html}{\out{&omega;}}{\eqn{\omega}} instead of `Omega`).
#'
#' @details `summary()` is a convenient shortcut for
#' `print(object, select = "minimal", show_sigma = TRUE, show_formula = TRUE)`.
#'
Expand Down
3 changes: 2 additions & 1 deletion man/display.parameters_model.Rd

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

2 changes: 1 addition & 1 deletion man/format_parameters.Rd

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

5 changes: 4 additions & 1 deletion man/model_parameters.Rd

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

6 changes: 5 additions & 1 deletion man/print.compare_parameters.Rd

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

8 changes: 6 additions & 2 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 2e2ce84

Please sign in to comment.