Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 3 additions & 0 deletions R/ard_aod_wald_test.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please avoid making updates based on opinionated ways of documenting functions. I like having help files.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noted, I will not remove internal help pages.

I removed the help page because CRAN requests to have examples and document values too for the internal help pages.
Internal help pages are not listed on the index but users can reach them if they want. I will simply fill in the section with NULL.

.extract_wald_results <- function(wald_test) {
df <- wald_test$result$chi2[("df")]
Expand Down
3 changes: 3 additions & 0 deletions R/ard_stats_prop_test.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as above.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noted, I will not remove internal help pages.

I removed the help page because CRAN requests to have examples and document values too for the internal help pages.
Internal help pages are not listed on the index but users can reach them if they want. I will simply fill in the sections with NULL.

.format_proptest_results <- function(by, variable, lst_tidy, ...) {
# build ARD ------------------------------------------------------------------
Expand Down
4 changes: 4 additions & 0 deletions R/deprecated.R
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
#'
#' @name deprecated
#' @keywords internal
#' @examples
#' NULL
#' @returns See each individual function help page.
#'
NULL

# v0.3.0 -----------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/ard_effectsize_hedges_g.Rd

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

3 changes: 2 additions & 1 deletion man/ard_emmeans.Rd

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

1 change: 1 addition & 0 deletions man/cardx-package.Rd

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

6 changes: 6 additions & 0 deletions man/deprecated.Rd

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

4 changes: 4 additions & 0 deletions man/dot-extract_wald_results.Rd

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

4 changes: 4 additions & 0 deletions man/dot-format_proptest_results.Rd

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

4 changes: 2 additions & 2 deletions man/reexports.Rd

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

Loading