diff --git a/R/1_model_parameters.R b/R/1_model_parameters.R index 059d95ee1..13c6e67cd 100644 --- a/R/1_model_parameters.R +++ b/R/1_model_parameters.R @@ -37,20 +37,22 @@ #' #' @param model Statistical Model. #' @param ... Arguments passed to or from other methods. Non-documented -#' arguments are `digits`, `p_digits`, `ci_digits` and `footer_digits` to set -#' the number of digits for the output. If `s_value = TRUE`, the p-value will -#' be replaced by the S-value in the output (cf. _Rafi and Greenland 2020_). -#' `pd` adds an additional column with the _probability of direction_ (see -#' [`bayestestR::p_direction()`] for details). `groups` can be used to group -#' coefficients. It will be passed to the print-method, or can directly be used -#' in `print()`, see documentation in [`print.parameters_model()`]. Furthermore, -#' see 'Examples' in [`model_parameters.default()`]. For developers, whose -#' interest mainly is to get a "tidy" data frame of model summaries, it is -#' recommended to set `pretty_names = FALSE` to speed up computation of the -#' summary table. -#' -#' @seealso [insight::standardize_names()] to -#' rename columns into a consistent, standardized naming scheme. +#' arguments are +#' - `digits`, `p_digits`, `ci_digits` and `footer_digits` to set the number of +#' digits for the output. `groups` can be used to group coefficients. These +#' arguments will be passed to the print-method, or can directly be used in +#' `print()`, see documentation in [`print.parameters_model()`]. +#' - If `s_value = TRUE`, the p-value will be replaced by the S-value in the +#' output (cf. _Rafi and Greenland 2020_). +#' - `pd` adds an additional column with the _probability of direction_ (see +#' [`bayestestR::p_direction()`] for details). Furthermore, see 'Examples' in +#' [`model_parameters.default()`]. +#' - For developers, whose interest mainly is to get a "tidy" data frame of +#' model summaries, it is recommended to set `pretty_names = FALSE` to speed +#' up computation of the summary table. +#' +#' @seealso [insight::standardize_names()] to rename columns into a consistent, +#' standardized naming scheme. #' #' @note The [`print()`][print.parameters_model] method has several #' arguments to tweak the output. There is also a @@ -491,18 +493,22 @@ parameters <- model_parameters #' names. #' @param ... Arguments passed to or from other methods. For instance, when #' `bootstrap = TRUE`, arguments like `type` or `parallel` are passed down to -#' `bootstrap_model()`. Further non-documented arguments are `digits`, -#' `p_digits`, `ci_digits` and `footer_digits` to set the number of digits for -#' the output. If `s_value = TRUE`, the p-value will be replaced by the -#' S-value in the output (cf. _Rafi and Greenland 2020_). `pd` adds an -#' additional column with the _probability of direction_ (see -#' [`bayestestR::p_direction()`] for details). `groups` can be used to group -#' coefficients. It will be passed to the print-method, or can directly be -#' used in `print()`, see documentation in [`print.parameters_model()`]. -#' Furthermore, see 'Examples' for this function. For developers, whose -#' interest mainly is to get a "tidy" data frame of model summaries, it is -#' recommended to set `pretty_names = FALSE` to speed up computation of the -#' summary table. +#' `bootstrap_model()`. +#' +#' Further non-documented arguments are: +#' +#' - `digits`, `p_digits`, `ci_digits` and `footer_digits` to set the number of +#' digits for the output. `groups` can be used to group coefficients. These +#' arguments will be passed to the print-method, or can directly be used in +#' `print()`, see documentation in [`print.parameters_model()`]. +#' - If `s_value = TRUE`, the p-value will be replaced by the S-value in the +#' output (cf. _Rafi and Greenland 2020_). +#' - `pd` adds an additional column with the _probability of direction_ (see +#' [`bayestestR::p_direction()`] for details). urthermore, see 'Examples' for +#' this function. +#' - For developers, whose interest mainly is to get a "tidy" data frame of +#' model summaries, it is recommended to set `pretty_names = FALSE` to speed +#' up computation of the summary table. #' @param drop See `keep`. #' @param verbose Toggle warnings and messages. #' @inheritParams standard_error diff --git a/R/methods_lme4.R b/R/methods_lme4.R index cc08a27e5..7e282a20d 100644 --- a/R/methods_lme4.R +++ b/R/methods_lme4.R @@ -34,18 +34,22 @@ #' or omit calculation of confidence intervals. #' @param ... Arguments passed to or from other methods. For instance, when #' `bootstrap = TRUE`, arguments like `type` or `parallel` are passed down to -#' `bootstrap_model()`. Further non-documented arguments are `digits`, -#' `p_digits`, `ci_digits` and `footer_digits` to set the number of digits for -#' the output. If `s_value = TRUE`, the p-value will be replaced by the -#' S-value in the output (cf. _Rafi and Greenland 2020_). `pd` adds an -#' additional column with the _probability of direction_ (see -#' [`bayestestR::p_direction()`] for details). `groups` can be used to group -#' coefficients. It will be passed to the print-method, or can directly be -#' used in `print()`, see documentation in [`print.parameters_model()`]. -#' Furthermore, see 'Examples' in [`model_parameters.default()`]. For -#' developers, whose interest mainly is to get a "tidy" data frame of model -#' summaries, it is recommended to set `pretty_names = FALSE` to speed up -#' computation of the summary table. +#' `bootstrap_model()`. +#' +#' Further non-documented arguments are: +#' +#' - `digits`, `p_digits`, `ci_digits` and `footer_digits` to set the number of +#' digits for the output. `groups` can be used to group coefficients. These +#' arguments will be passed to the print-method, or can directly be used in +#' `print()`, see documentation in [`print.parameters_model()`]. +#' - If `s_value = TRUE`, the p-value will be replaced by the S-value in the +#' output (cf. _Rafi and Greenland 2020_). +#' - `pd` adds an additional column with the _probability of direction_ (see +#' [`bayestestR::p_direction()`] for details). urthermore, see 'Examples' for +#' this function. +#' - For developers, whose interest mainly is to get a "tidy" data frame of +#' model summaries, it is recommended to set `pretty_names = FALSE` to speed +#' up computation of the summary table. #' #' @inheritParams model_parameters.default #' @inheritParams model_parameters.stanreg diff --git a/man/model_parameters.Rd b/man/model_parameters.Rd index c75d74853..80f067b8f 100644 --- a/man/model_parameters.Rd +++ b/man/model_parameters.Rd @@ -13,17 +13,21 @@ parameters(model, ...) \item{model}{Statistical Model.} \item{...}{Arguments passed to or from other methods. Non-documented -arguments are \code{digits}, \code{p_digits}, \code{ci_digits} and \code{footer_digits} to set -the number of digits for the output. If \code{s_value = TRUE}, the p-value will -be replaced by the S-value in the output (cf. \emph{Rafi and Greenland 2020}). -\code{pd} adds an additional column with the \emph{probability of direction} (see -\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). \code{groups} can be used to group -coefficients. It will be passed to the print-method, or can directly be used -in \code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. Furthermore, -see 'Examples' in \code{\link[=model_parameters.default]{model_parameters.default()}}. For developers, whose -interest mainly is to get a "tidy" data frame of model summaries, it is -recommended to set \code{pretty_names = FALSE} to speed up computation of the -summary table.} +arguments are +\itemize{ +\item \code{digits}, \code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of +digits for the output. \code{groups} can be used to group coefficients. These +arguments will be passed to the print-method, or can directly be used in +\code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. +\item If \code{s_value = TRUE}, the p-value will be replaced by the S-value in the +output (cf. \emph{Rafi and Greenland 2020}). +\item \code{pd} adds an additional column with the \emph{probability of direction} (see +\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). Furthermore, see 'Examples' in +\code{\link[=model_parameters.default]{model_parameters.default()}}. +\item For developers, whose interest mainly is to get a "tidy" data frame of +model summaries, it is recommended to set \code{pretty_names = FALSE} to speed +up computation of the summary table. +}} } \value{ A data frame of indices related to the model's parameters. @@ -475,6 +479,6 @@ Synthese 200, 89 (2022). \doi{10.1007/s11229-022-03560-x} } } \seealso{ -\code{\link[insight:standardize_names]{insight::standardize_names()}} to -rename columns into a consistent, standardized naming scheme. +\code{\link[insight:standardize_names]{insight::standardize_names()}} to rename columns into a consistent, +standardized naming scheme. } diff --git a/man/model_parameters.averaging.Rd b/man/model_parameters.averaging.Rd index c9c8cbdd1..8f3ab7f94 100644 --- a/man/model_parameters.averaging.Rd +++ b/man/model_parameters.averaging.Rd @@ -287,18 +287,23 @@ names.} \item{...}{Arguments passed to or from other methods. For instance, when \code{bootstrap = TRUE}, arguments like \code{type} or \code{parallel} are passed down to -\code{bootstrap_model()}. Further non-documented arguments are \code{digits}, -\code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of digits for -the output. If \code{s_value = TRUE}, the p-value will be replaced by the -S-value in the output (cf. \emph{Rafi and Greenland 2020}). \code{pd} adds an -additional column with the \emph{probability of direction} (see -\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). \code{groups} can be used to group -coefficients. It will be passed to the print-method, or can directly be -used in \code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. -Furthermore, see 'Examples' for this function. For developers, whose -interest mainly is to get a "tidy" data frame of model summaries, it is -recommended to set \code{pretty_names = FALSE} to speed up computation of the -summary table.} +\code{bootstrap_model()}. + +Further non-documented arguments are: +\itemize{ +\item \code{digits}, \code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of +digits for the output. \code{groups} can be used to group coefficients. These +arguments will be passed to the print-method, or can directly be used in +\code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. +\item If \code{s_value = TRUE}, the p-value will be replaced by the S-value in the +output (cf. \emph{Rafi and Greenland 2020}). +\item \code{pd} adds an additional column with the \emph{probability of direction} (see +\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). urthermore, see 'Examples' for +this function. +\item For developers, whose interest mainly is to get a "tidy" data frame of +model summaries, it is recommended to set \code{pretty_names = FALSE} to speed +up computation of the summary table. +}} \item{include_studies}{Logical, if \code{TRUE} (default), includes parameters for all studies. Else, only parameters for overall-effects are shown.} diff --git a/man/model_parameters.cgam.Rd b/man/model_parameters.cgam.Rd index c2a4afa4b..91b385eb8 100644 --- a/man/model_parameters.cgam.Rd +++ b/man/model_parameters.cgam.Rd @@ -141,18 +141,23 @@ names.} \item{...}{Arguments passed to or from other methods. For instance, when \code{bootstrap = TRUE}, arguments like \code{type} or \code{parallel} are passed down to -\code{bootstrap_model()}. Further non-documented arguments are \code{digits}, -\code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of digits for -the output. If \code{s_value = TRUE}, the p-value will be replaced by the -S-value in the output (cf. \emph{Rafi and Greenland 2020}). \code{pd} adds an -additional column with the \emph{probability of direction} (see -\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). \code{groups} can be used to group -coefficients. It will be passed to the print-method, or can directly be -used in \code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. -Furthermore, see 'Examples' for this function. For developers, whose -interest mainly is to get a "tidy" data frame of model summaries, it is -recommended to set \code{pretty_names = FALSE} to speed up computation of the -summary table.} +\code{bootstrap_model()}. + +Further non-documented arguments are: +\itemize{ +\item \code{digits}, \code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of +digits for the output. \code{groups} can be used to group coefficients. These +arguments will be passed to the print-method, or can directly be used in +\code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. +\item If \code{s_value = TRUE}, the p-value will be replaced by the S-value in the +output (cf. \emph{Rafi and Greenland 2020}). +\item \code{pd} adds an additional column with the \emph{probability of direction} (see +\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). urthermore, see 'Examples' for +this function. +\item For developers, whose interest mainly is to get a "tidy" data frame of +model summaries, it is recommended to set \code{pretty_names = FALSE} to speed +up computation of the summary table. +}} \item{es_type}{The effect size of interest. Not that possibly not all effect sizes are applicable to the model object. See 'Details'. For Anova diff --git a/man/model_parameters.default.Rd b/man/model_parameters.default.Rd index 0b6efc8d0..a291af51e 100644 --- a/man/model_parameters.default.Rd +++ b/man/model_parameters.default.Rd @@ -186,18 +186,23 @@ names.} \item{...}{Arguments passed to or from other methods. For instance, when \code{bootstrap = TRUE}, arguments like \code{type} or \code{parallel} are passed down to -\code{bootstrap_model()}. Further non-documented arguments are \code{digits}, -\code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of digits for -the output. If \code{s_value = TRUE}, the p-value will be replaced by the -S-value in the output (cf. \emph{Rafi and Greenland 2020}). \code{pd} adds an -additional column with the \emph{probability of direction} (see -\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). \code{groups} can be used to group -coefficients. It will be passed to the print-method, or can directly be -used in \code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. -Furthermore, see 'Examples' for this function. For developers, whose -interest mainly is to get a "tidy" data frame of model summaries, it is -recommended to set \code{pretty_names = FALSE} to speed up computation of the -summary table.} +\code{bootstrap_model()}. + +Further non-documented arguments are: +\itemize{ +\item \code{digits}, \code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of +digits for the output. \code{groups} can be used to group coefficients. These +arguments will be passed to the print-method, or can directly be used in +\code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. +\item If \code{s_value = TRUE}, the p-value will be replaced by the S-value in the +output (cf. \emph{Rafi and Greenland 2020}). +\item \code{pd} adds an additional column with the \emph{probability of direction} (see +\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). urthermore, see 'Examples' for +this function. +\item For developers, whose interest mainly is to get a "tidy" data frame of +model summaries, it is recommended to set \code{pretty_names = FALSE} to speed +up computation of the summary table. +}} } \value{ A data frame of indices related to the model's parameters. diff --git a/man/model_parameters.glht.Rd b/man/model_parameters.glht.Rd index b71244fd3..ea52fa1a8 100644 --- a/man/model_parameters.glht.Rd +++ b/man/model_parameters.glht.Rd @@ -59,18 +59,23 @@ names.} \item{...}{Arguments passed to or from other methods. For instance, when \code{bootstrap = TRUE}, arguments like \code{type} or \code{parallel} are passed down to -\code{bootstrap_model()}. Further non-documented arguments are \code{digits}, -\code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of digits for -the output. If \code{s_value = TRUE}, the p-value will be replaced by the -S-value in the output (cf. \emph{Rafi and Greenland 2020}). \code{pd} adds an -additional column with the \emph{probability of direction} (see -\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). \code{groups} can be used to group -coefficients. It will be passed to the print-method, or can directly be -used in \code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. -Furthermore, see 'Examples' for this function. For developers, whose -interest mainly is to get a "tidy" data frame of model summaries, it is -recommended to set \code{pretty_names = FALSE} to speed up computation of the -summary table.} +\code{bootstrap_model()}. + +Further non-documented arguments are: +\itemize{ +\item \code{digits}, \code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of +digits for the output. \code{groups} can be used to group coefficients. These +arguments will be passed to the print-method, or can directly be used in +\code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. +\item If \code{s_value = TRUE}, the p-value will be replaced by the S-value in the +output (cf. \emph{Rafi and Greenland 2020}). +\item \code{pd} adds an additional column with the \emph{probability of direction} (see +\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). urthermore, see 'Examples' for +this function. +\item For developers, whose interest mainly is to get a "tidy" data frame of +model summaries, it is recommended to set \code{pretty_names = FALSE} to speed +up computation of the summary table. +}} } \value{ A data frame of indices related to the model's parameters. diff --git a/man/model_parameters.htest.Rd b/man/model_parameters.htest.Rd index 3d83e29c7..2bc8ffd18 100644 --- a/man/model_parameters.htest.Rd +++ b/man/model_parameters.htest.Rd @@ -47,18 +47,23 @@ models, can also be a character vector with multiple effect size names.} \item{...}{Arguments passed to or from other methods. For instance, when \code{bootstrap = TRUE}, arguments like \code{type} or \code{parallel} are passed down to -\code{bootstrap_model()}. Further non-documented arguments are \code{digits}, -\code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of digits for -the output. If \code{s_value = TRUE}, the p-value will be replaced by the -S-value in the output (cf. \emph{Rafi and Greenland 2020}). \code{pd} adds an -additional column with the \emph{probability of direction} (see -\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). \code{groups} can be used to group -coefficients. It will be passed to the print-method, or can directly be -used in \code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. -Furthermore, see 'Examples' for this function. For developers, whose -interest mainly is to get a "tidy" data frame of model summaries, it is -recommended to set \code{pretty_names = FALSE} to speed up computation of the -summary table.} +\code{bootstrap_model()}. + +Further non-documented arguments are: +\itemize{ +\item \code{digits}, \code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of +digits for the output. \code{groups} can be used to group coefficients. These +arguments will be passed to the print-method, or can directly be used in +\code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. +\item If \code{s_value = TRUE}, the p-value will be replaced by the S-value in the +output (cf. \emph{Rafi and Greenland 2020}). +\item \code{pd} adds an additional column with the \emph{probability of direction} (see +\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). urthermore, see 'Examples' for +this function. +\item For developers, whose interest mainly is to get a "tidy" data frame of +model summaries, it is recommended to set \code{pretty_names = FALSE} to speed +up computation of the summary table. +}} \item{ci_method}{Method for computing degrees of freedom for confidence intervals (CI) and the related p-values. Allowed are following diff --git a/man/model_parameters.merMod.Rd b/man/model_parameters.merMod.Rd index 63bb7e6ce..8ca2889ca 100644 --- a/man/model_parameters.merMod.Rd +++ b/man/model_parameters.merMod.Rd @@ -296,18 +296,23 @@ names.} \item{...}{Arguments passed to or from other methods. For instance, when \code{bootstrap = TRUE}, arguments like \code{type} or \code{parallel} are passed down to -\code{bootstrap_model()}. Further non-documented arguments are \code{digits}, -\code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of digits for -the output. If \code{s_value = TRUE}, the p-value will be replaced by the -S-value in the output (cf. \emph{Rafi and Greenland 2020}). \code{pd} adds an -additional column with the \emph{probability of direction} (see -\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). \code{groups} can be used to group -coefficients. It will be passed to the print-method, or can directly be -used in \code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. -Furthermore, see 'Examples' in \code{\link[=model_parameters.default]{model_parameters.default()}}. For -developers, whose interest mainly is to get a "tidy" data frame of model -summaries, it is recommended to set \code{pretty_names = FALSE} to speed up -computation of the summary table.} +\code{bootstrap_model()}. + +Further non-documented arguments are: +\itemize{ +\item \code{digits}, \code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of +digits for the output. \code{groups} can be used to group coefficients. These +arguments will be passed to the print-method, or can directly be used in +\code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. +\item If \code{s_value = TRUE}, the p-value will be replaced by the S-value in the +output (cf. \emph{Rafi and Greenland 2020}). +\item \code{pd} adds an additional column with the \emph{probability of direction} (see +\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). urthermore, see 'Examples' for +this function. +\item For developers, whose interest mainly is to get a "tidy" data frame of +model summaries, it is recommended to set \code{pretty_names = FALSE} to speed +up computation of the summary table. +}} \item{component}{Should all parameters, parameters for the conditional model, for the zero-inflation part of the model, or the dispersion model be returned? diff --git a/man/model_parameters.mlm.Rd b/man/model_parameters.mlm.Rd index 01e3cb855..637f81f70 100644 --- a/man/model_parameters.mlm.Rd +++ b/man/model_parameters.mlm.Rd @@ -155,18 +155,23 @@ names.} \item{...}{Arguments passed to or from other methods. For instance, when \code{bootstrap = TRUE}, arguments like \code{type} or \code{parallel} are passed down to -\code{bootstrap_model()}. Further non-documented arguments are \code{digits}, -\code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of digits for -the output. If \code{s_value = TRUE}, the p-value will be replaced by the -S-value in the output (cf. \emph{Rafi and Greenland 2020}). \code{pd} adds an -additional column with the \emph{probability of direction} (see -\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). \code{groups} can be used to group -coefficients. It will be passed to the print-method, or can directly be -used in \code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. -Furthermore, see 'Examples' for this function. For developers, whose -interest mainly is to get a "tidy" data frame of model summaries, it is -recommended to set \code{pretty_names = FALSE} to speed up computation of the -summary table.} +\code{bootstrap_model()}. + +Further non-documented arguments are: +\itemize{ +\item \code{digits}, \code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of +digits for the output. \code{groups} can be used to group coefficients. These +arguments will be passed to the print-method, or can directly be used in +\code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. +\item If \code{s_value = TRUE}, the p-value will be replaced by the S-value in the +output (cf. \emph{Rafi and Greenland 2020}). +\item \code{pd} adds an additional column with the \emph{probability of direction} (see +\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). urthermore, see 'Examples' for +this function. +\item For developers, whose interest mainly is to get a "tidy" data frame of +model summaries, it is recommended to set \code{pretty_names = FALSE} to speed +up computation of the summary table. +}} \item{summary}{Deprecated, please use \code{info} instead.} diff --git a/man/model_parameters.rma.Rd b/man/model_parameters.rma.Rd index e58a6844f..e552f53d1 100644 --- a/man/model_parameters.rma.Rd +++ b/man/model_parameters.rma.Rd @@ -89,18 +89,23 @@ names.} \item{...}{Arguments passed to or from other methods. For instance, when \code{bootstrap = TRUE}, arguments like \code{type} or \code{parallel} are passed down to -\code{bootstrap_model()}. Further non-documented arguments are \code{digits}, -\code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of digits for -the output. If \code{s_value = TRUE}, the p-value will be replaced by the -S-value in the output (cf. \emph{Rafi and Greenland 2020}). \code{pd} adds an -additional column with the \emph{probability of direction} (see -\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). \code{groups} can be used to group -coefficients. It will be passed to the print-method, or can directly be -used in \code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. -Furthermore, see 'Examples' for this function. For developers, whose -interest mainly is to get a "tidy" data frame of model summaries, it is -recommended to set \code{pretty_names = FALSE} to speed up computation of the -summary table.} +\code{bootstrap_model()}. + +Further non-documented arguments are: +\itemize{ +\item \code{digits}, \code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of +digits for the output. \code{groups} can be used to group coefficients. These +arguments will be passed to the print-method, or can directly be used in +\code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. +\item If \code{s_value = TRUE}, the p-value will be replaced by the S-value in the +output (cf. \emph{Rafi and Greenland 2020}). +\item \code{pd} adds an additional column with the \emph{probability of direction} (see +\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). urthermore, see 'Examples' for +this function. +\item For developers, whose interest mainly is to get a "tidy" data frame of +model summaries, it is recommended to set \code{pretty_names = FALSE} to speed +up computation of the summary table. +}} } \value{ A data frame of indices related to the model's parameters. diff --git a/man/model_parameters.zcpglm.Rd b/man/model_parameters.zcpglm.Rd index c9d67ae9d..e7f4965a6 100644 --- a/man/model_parameters.zcpglm.Rd +++ b/man/model_parameters.zcpglm.Rd @@ -121,18 +121,23 @@ names.} \item{...}{Arguments passed to or from other methods. For instance, when \code{bootstrap = TRUE}, arguments like \code{type} or \code{parallel} are passed down to -\code{bootstrap_model()}. Further non-documented arguments are \code{digits}, -\code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of digits for -the output. If \code{s_value = TRUE}, the p-value will be replaced by the -S-value in the output (cf. \emph{Rafi and Greenland 2020}). \code{pd} adds an -additional column with the \emph{probability of direction} (see -\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). \code{groups} can be used to group -coefficients. It will be passed to the print-method, or can directly be -used in \code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. -Furthermore, see 'Examples' for this function. For developers, whose -interest mainly is to get a "tidy" data frame of model summaries, it is -recommended to set \code{pretty_names = FALSE} to speed up computation of the -summary table.} +\code{bootstrap_model()}. + +Further non-documented arguments are: +\itemize{ +\item \code{digits}, \code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of +digits for the output. \code{groups} can be used to group coefficients. These +arguments will be passed to the print-method, or can directly be used in +\code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. +\item If \code{s_value = TRUE}, the p-value will be replaced by the S-value in the +output (cf. \emph{Rafi and Greenland 2020}). +\item \code{pd} adds an additional column with the \emph{probability of direction} (see +\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). urthermore, see 'Examples' for +this function. +\item For developers, whose interest mainly is to get a "tidy" data frame of +model summaries, it is recommended to set \code{pretty_names = FALSE} to speed +up computation of the summary table. +}} } \value{ A data frame of indices related to the model's parameters. diff --git a/man/n_clusters.Rd b/man/n_clusters.Rd index 13b385a05..0a7f1561e 100644 --- a/man/n_clusters.Rd +++ b/man/n_clusters.Rd @@ -95,18 +95,23 @@ as \code{method}).} \item{...}{Arguments passed to or from other methods. For instance, when \code{bootstrap = TRUE}, arguments like \code{type} or \code{parallel} are passed down to -\code{bootstrap_model()}. Further non-documented arguments are \code{digits}, -\code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of digits for -the output. If \code{s_value = TRUE}, the p-value will be replaced by the -S-value in the output (cf. \emph{Rafi and Greenland 2020}). \code{pd} adds an -additional column with the \emph{probability of direction} (see -\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). \code{groups} can be used to group -coefficients. It will be passed to the print-method, or can directly be -used in \code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. -Furthermore, see 'Examples' for this function. For developers, whose -interest mainly is to get a "tidy" data frame of model summaries, it is -recommended to set \code{pretty_names = FALSE} to speed up computation of the -summary table.} +\code{bootstrap_model()}. + +Further non-documented arguments are: +\itemize{ +\item \code{digits}, \code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of +digits for the output. \code{groups} can be used to group coefficients. These +arguments will be passed to the print-method, or can directly be used in +\code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. +\item If \code{s_value = TRUE}, the p-value will be replaced by the S-value in the +output (cf. \emph{Rafi and Greenland 2020}). +\item \code{pd} adds an additional column with the \emph{probability of direction} (see +\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). urthermore, see 'Examples' for +this function. +\item For developers, whose interest mainly is to get a "tidy" data frame of +model summaries, it is recommended to set \code{pretty_names = FALSE} to speed +up computation of the summary table. +}} \item{clustering_function, gap_method}{Other arguments passed to other functions. \code{clustering_function} is used by \code{fviz_nbclust()} and diff --git a/man/p_function.Rd b/man/p_function.Rd index 62c396a7c..fa210dc77 100644 --- a/man/p_function.Rd +++ b/man/p_function.Rd @@ -136,17 +136,21 @@ names.} \item{verbose}{Toggle warnings and messages.} \item{...}{Arguments passed to or from other methods. Non-documented -arguments are \code{digits}, \code{p_digits}, \code{ci_digits} and \code{footer_digits} to set -the number of digits for the output. If \code{s_value = TRUE}, the p-value will -be replaced by the S-value in the output (cf. \emph{Rafi and Greenland 2020}). -\code{pd} adds an additional column with the \emph{probability of direction} (see -\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). \code{groups} can be used to group -coefficients. It will be passed to the print-method, or can directly be used -in \code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. Furthermore, -see 'Examples' in \code{\link[=model_parameters.default]{model_parameters.default()}}. For developers, whose -interest mainly is to get a "tidy" data frame of model summaries, it is -recommended to set \code{pretty_names = FALSE} to speed up computation of the -summary table.} +arguments are +\itemize{ +\item \code{digits}, \code{p_digits}, \code{ci_digits} and \code{footer_digits} to set the number of +digits for the output. \code{groups} can be used to group coefficients. These +arguments will be passed to the print-method, or can directly be used in +\code{print()}, see documentation in \code{\link[=print.parameters_model]{print.parameters_model()}}. +\item If \code{s_value = TRUE}, the p-value will be replaced by the S-value in the +output (cf. \emph{Rafi and Greenland 2020}). +\item \code{pd} adds an additional column with the \emph{probability of direction} (see +\code{\link[bayestestR:p_direction]{bayestestR::p_direction()}} for details). Furthermore, see 'Examples' in +\code{\link[=model_parameters.default]{model_parameters.default()}}. +\item For developers, whose interest mainly is to get a "tidy" data frame of +model summaries, it is recommended to set \code{pretty_names = FALSE} to speed +up computation of the summary table. +}} } \value{ A data frame with p-values and compatibility intervals.