diff --git a/DESCRIPTION b/DESCRIPTION index 0bd36fe2c..f17f25707 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -49,10 +49,10 @@ Suggests: Remotes: insightsengineering/cards@main Config/Needs/website: insightsengineering/nesttemplate +Config/roxygen2/version: 8.0.0 Config/testthat/edition: 3 Config/testthat/parallel: true Encoding: UTF-8 Language: en-US LazyData: true Roxygen: list(markdown = TRUE) -RoxygenNote: 7.3.3 diff --git a/R/ard_aod_wald_test.R b/R/ard_aod_wald_test.R index d3ed94f4d..517a40b38 100644 --- a/R/ard_aod_wald_test.R +++ b/R/ard_aod_wald_test.R @@ -109,6 +109,9 @@ ard_aod_wald_test <- function(x, tidy_fun = broom.helpers::tidy_with_broom_or_pa #' @param wald_test (`data.frame`)\cr wald test object object from `aod::wald.test()` #' #' @return a data frame containing the wald test results. +#' @examples +#' NULL +#' #' @keywords internal .extract_wald_results <- function(wald_test) { df <- wald_test$result$chi2[("df")] diff --git a/R/ard_stats_prop_test.R b/R/ard_stats_prop_test.R index 7e00c744e..7312a511b 100644 --- a/R/ard_stats_prop_test.R +++ b/R/ard_stats_prop_test.R @@ -98,6 +98,9 @@ ard_stats_prop_test <- function(data, by, variables, conf.level = 0.95, ...) { #' @param ... passed to `prop.test(...)` #' #' @return ARD data frame +#' @examples +#' NULL +#' #' @keywords internal .format_proptest_results <- function(by, variable, lst_tidy, ...) { # build ARD ------------------------------------------------------------------ diff --git a/R/deprecated.R b/R/deprecated.R index aa0e62927..8b0e5bc78 100644 --- a/R/deprecated.R +++ b/R/deprecated.R @@ -7,6 +7,10 @@ #' #' @name deprecated #' @keywords internal +#' @examples +#' NULL +#' @returns See each individual function help page. +#' NULL # v0.3.0 ----------------------------------------------------------------------- diff --git a/man/ard_effectsize_hedges_g.Rd b/man/ard_effectsize_hedges_g.Rd index 32d8148db..cf47c9acf 100644 --- a/man/ard_effectsize_hedges_g.Rd +++ b/man/ard_effectsize_hedges_g.Rd @@ -33,7 +33,7 @@ ARD data frame } \description{ Analysis results data for paired and non-paired Hedge's G Effect Size Test -using \code{\link[effectsize:cohens_d]{effectsize::hedges_g()}}. +using \code{\link[effectsize:hedges_g]{effectsize::hedges_g()}}. } \details{ For the \code{ard_effectsize_hedges_g()} function, the data is expected to be one row per subject. diff --git a/man/ard_emmeans.Rd b/man/ard_emmeans.Rd index b7e5f180b..635688973 100644 --- a/man/ard_emmeans.Rd +++ b/man/ard_emmeans.Rd @@ -1,5 +1,6 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/ard_emmeans_contrast.R, R/ard_emmeans_emmeans.R +% Please edit documentation in R/ard_emmeans_contrast.R, +% R/ard_emmeans_emmeans.R \name{ard_emmeans_contrast} \alias{ard_emmeans_contrast} \alias{ard_emmeans_emmeans} diff --git a/man/cardx-package.Rd b/man/cardx-package.Rd index b0cfa13d9..acd66dc07 100644 --- a/man/cardx-package.Rd +++ b/man/cardx-package.Rd @@ -24,6 +24,7 @@ Useful links: Authors: \itemize{ + \item Daniel D. Sjoberg \email{danield.sjoberg@gmail.com} (\href{https://orcid.org/0000-0003-0862-2018}{ORCID}) \item Abinaya Yogasekaram \email{abinaya.yogasekaram@contractors.roche.com} \item Emily de la Rua \email{emily.de_la_rua@contractors.roche.com} } diff --git a/man/deprecated.Rd b/man/deprecated.Rd index f6641ca52..64a3ecb72 100644 --- a/man/deprecated.Rd +++ b/man/deprecated.Rd @@ -19,9 +19,15 @@ ard_categorical_max(...) ard_emmeans_mean_difference(...) } +\value{ +See each individual function help page. +} \description{ \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}}\cr Some functions have been deprecated and are no longer being actively supported. } +\examples{ +NULL +} \keyword{internal} diff --git a/man/dot-extract_wald_results.Rd b/man/dot-extract_wald_results.Rd index 24b23eb78..0b718e806 100644 --- a/man/dot-extract_wald_results.Rd +++ b/man/dot-extract_wald_results.Rd @@ -14,5 +14,9 @@ a data frame containing the wald test results. } \description{ Extract data from wald.test object +} +\examples{ +NULL + } \keyword{internal} diff --git a/man/dot-format_proptest_results.Rd b/man/dot-format_proptest_results.Rd index 05c97ef24..b3c601010 100644 --- a/man/dot-format_proptest_results.Rd +++ b/man/dot-format_proptest_results.Rd @@ -22,5 +22,9 @@ ARD data frame } \description{ Convert prop.test to ARD +} +\examples{ +NULL + } \keyword{internal} diff --git a/man/reexports.Rd b/man/reexports.Rd index 1105c1cf2..00c5c2bfc 100644 --- a/man/reexports.Rd +++ b/man/reexports.Rd @@ -31,8 +31,8 @@ These objects are imported from other packages. Follow the links below to see their documentation. \describe{ - \item{cards}{\code{\link[cards]{ard_attributes}}, \code{\link[cards:deprecated]{ard_categorical}}, \code{\link[cards:deprecated]{ard_continuous}}, \code{\link[cards:deprecated]{ard_dichotomous}}, \code{\link[cards]{ard_missing}}, \code{\link[cards]{ard_summary}}, \code{\link[cards]{ard_tabulate}}, \code{\link[cards]{ard_tabulate_value}}, \code{\link[cards]{ard_total_n}}} + \item{cards}{\code{\link[cards:ard_attributes]{ard_attributes()}}, \code{\link[cards:ard_categorical]{ard_categorical()}}, \code{\link[cards:ard_continuous]{ard_continuous()}}, \code{\link[cards:ard_dichotomous]{ard_dichotomous()}}, \code{\link[cards:ard_missing]{ard_missing()}}, \code{\link[cards:ard_summary]{ard_summary()}}, \code{\link[cards:ard_tabulate]{ard_tabulate()}}, \code{\link[cards:ard_tabulate_value]{ard_tabulate_value()}}, \code{\link[cards:ard_total_n]{ard_total_n()}}} - \item{dplyr}{\code{\link[dplyr:reexports]{\%>\%}}, \code{\link[dplyr:reexports]{all_of}}, \code{\link[dplyr:reexports]{any_of}}, \code{\link[dplyr:reexports]{contains}}, \code{\link[dplyr:reexports]{ends_with}}, \code{\link[dplyr:reexports]{everything}}, \code{\link[dplyr:reexports]{last_col}}, \code{\link[dplyr:reexports]{matches}}, \code{\link[dplyr:reexports]{num_range}}, \code{\link[dplyr:reexports]{one_of}}, \code{\link[dplyr:reexports]{starts_with}}, \code{\link[dplyr:reexports]{where}}} + \item{dplyr}{\code{\link[dplyr:\%>\%]{\%>\%}}, \code{\link[dplyr:all_of]{all_of}}, \code{\link[dplyr:any_of]{any_of}}, \code{\link[dplyr:contains]{contains}}, \code{\link[dplyr:ends_with]{ends_with}}, \code{\link[dplyr:everything]{everything}}, \code{\link[dplyr:last_col]{last_col}}, \code{\link[dplyr:matches]{matches}}, \code{\link[dplyr:num_range]{num_range}}, \code{\link[dplyr:one_of]{one_of}}, \code{\link[dplyr:starts_with]{starts_with}}, \code{\link[dplyr:where]{where}}} }}