docs

easystats · Jun 10, 2024 · e7339a4 · e7339a4
1 parent 9a944e0
commit e7339a4
Show file tree

Hide file tree

Showing 6 changed files with 262 additions and 19 deletions.
diff --git a/R/format.R b/R/format.R
@@ -240,6 +240,7 @@ format.parameters_brms_meta <- format.parameters_model
 # Compare parameters ----------------------
 
 
+#' @rdname print.compare_parameters
 #' @inheritParams print.parameters_model
 #' @export
 format.compare_parameters <- function(x,

diff --git a/R/print.compare_parameters.R b/R/print.compare_parameters.R
@@ -1,3 +1,28 @@
+#' @title Print comparisons of model parameters
+#' @name print.compare_parameters
+#'
+#' @description A `print()`-method for objects from [`compare_parameters()`].
+#'
+#' @param x,object An object returned by [`compare_parameters()`].
+#' @inheritParams print.parameters_model
+#' @inheritSection print.parameters_model Global Options to Customize Messages and Tables when Printing
+#'
+#' @return Invisibly returns the original input object.
+#'
+#' @examples
+#' \donttest{
+#' data(iris)
+#' lm1 <- lm(Sepal.Length ~ Species, data = iris)
+#' lm2 <- lm(Sepal.Length ~ Species + Petal.Length, data = iris)
+#'
+#' # custom style
+#' result <- compare_parameters(lm1, lm2, select = "{estimate}{stars} ({se})")
+#' print(result)
+#'
+#' # custom style, in HTML
+#' result <- compare_parameters(lm1, lm2, select = "{estimate}<br>({se})|{p}")
+#' print_html(result)
+#' }
 #' @export
 print.compare_parameters <- function(x,
                                      split_components = TRUE,

diff --git a/R/print_html.R b/R/print_html.R
@@ -138,6 +138,7 @@ print_html.parameters_simulate <- print_html.parameters_model
 #' @export
 print_html.parameters_sem <- print_html.parameters_model
 
+#' @rdname print.compare_parameters
 #' @export
 print_html.compare_parameters <- function(x,
                                           caption = NULL,

diff --git a/R/print_md.R b/R/print_md.R
@@ -123,7 +123,7 @@ print_md.parameters_simulate <- print_md.parameters_model
 # compare parameters -------------------------
 
 
-#' @rdname display.parameters_model
+#' @rdname print.compare_parameters
 #' @export
 print_md.compare_parameters <- function(x,
                                         digits = 2,

diff --git a/man/display.parameters_model.Rd b/man/display.parameters_model.Rd
diff --git a/man/print.compare_parameters.Rd b/man/print.compare_parameters.Rd