docs

R/apply_table_theme.R

@@ -1,3 +1,9 @@
+#' @param out A `tinytable` object.
+#' @param x The underlying data frame, used to create `out`.
+#' @param theme The theme to apply to the table. One of `"default"`, `"grid"`,
+#' `"striped"`, `"bootstrap"`, or `"darklines"`.
+#' @param sub_header_positions A vector of row positions to apply a border to.
+#' Currently particular for internal use of other _easystats_ packages.
 #' @rdname export_table
 #' @export
 apply_table_theme <- function(out, x, theme = "default", sub_header_positions = NULL) {

R/get_auxiliary.R

@@ -78,17 +78,17 @@ get_auxiliary <- function(x,
 
 # dispersion parameter -----------------------
 
-
+#' @keywords internal
 get_dispersion <- function(x, ...) {
   UseMethod("get_dispersion")
 }
 
-
+#' @keywords internal
 get_dispersion.model_fit <- function(x, ...) {
   get_dispersion(x$fit, ...)
 }
 
-
+#' @keywords internal
 get_dispersion.glm <- function(x, verbose = TRUE, ...) {
   info <- model_info(x, verbose = verbose)
   disp <- NULL
@@ -103,7 +103,7 @@ get_dispersion.glm <- function(x, verbose = TRUE, ...) {
   disp
 }
 
-
+#' @keywords internal
 get_dispersion.glmerMod <- function(x, verbose = TRUE, ...) {
   info <- model_info(x, verbose = verbose)
   disp <- NULL
@@ -122,7 +122,7 @@ get_dispersion.glmerMod <- function(x, verbose = TRUE, ...) {
   disp
 }
 
-
+#' @keywords internal
 get_dispersion.glmmTMB <- function(x, verbose = TRUE, ...) {
   info <- model_info(x, verbose = verbose)
   disp <- NULL
@@ -135,13 +135,14 @@ get_dispersion.glmmTMB <- function(x, verbose = TRUE, ...) {
   disp
 }
 
-
+#' @keywords internal
 get_dispersion.brmsfit <- get_dispersion.glmmTMB
 
 
 
 # special ------------------
 
+#' @keywords internal
 .get_generic_aux <- function(x,
                              param,
                              summary = TRUE,