Skip to content

Commit 9ad0dad

Browse files
committed
Update denominator argument description
1 parent aa0d969 commit 9ad0dad

File tree

2 files changed

+19
-34
lines changed

2 files changed

+19
-34
lines changed

R/ard_hierarchical.R

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,20 @@
1818
#' @param id ([`tidy-select`][dplyr::dplyr_tidy_select])\cr
1919
#' an optional argument used to assert there are no duplicates within
2020
#' the `c(id, variables)` columns.
21+
#' @param denominator (`data.frame`, `integer`)\cr
22+
#' used to define the denominator and enhance the output.
23+
#' The argument is required for `ard_hierarchical()` and optional
24+
#' for `ard_hierarchical_count()`.
25+
#' - the univariate tabulations of the `by` variables are calculated with `denominator`,
26+
#' when a data frame is passed, e.g. tabulation of the treatment assignment
27+
#' counts that may appear in the header of a table.
28+
#' - the `denominator` argument must be specified when `id` is used to
29+
#' calculate the event rates.
2130
#' @inheritParams ard_categorical
2231
#'
2332
#' @return an ARD data frame of class 'card'
2433
#' @name ard_hierarchical
2534
#'
26-
#' @inheritSection ard_categorical Denominators
27-
#'
2835
#' @examples
2936
#' ard_hierarchical(
3037
#' data = ADAE |>

man/ard_hierarchical.Rd

Lines changed: 10 additions & 32 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)