in_rows: Create multiple rows in analysis or summary functions

In rtables: Reporting Tables

Create multiple rows in analysis or summary functions

Description

Define the cells that get placed into multiple rows in afun.

Usage

in_rows(
  ...,
  .list = NULL,
  .names = NULL,
  .labels = NULL,
  .formats = NULL,
  .indent_mods = NULL,
  .cell_footnotes = list(NULL),
  .row_footnotes = list(NULL),
  .aligns = NULL,
  .format_na_strs = NULL
)

Arguments

...	single row defining expressions.
.list	(list) list cell content (usually rcells). The .list is concatenated to ....
.names	(character or NULL) names of the returned list/structure.
.labels	(character or NULL) labels for the defined rows.
.formats	(character or NULL) formats for the values.
.indent_mods	(integer or NULL) indent modifications for the defined rows.
.cell_footnotes	(list) referential footnote messages to be associated by name with cells.
.row_footnotes	(list) referential footnotes messages to be associated by name with rows.
.aligns	(character or NULL) alignments for the cells. Standard for NULL is "center". See formatters::list_valid_aligns() for currently supported alignments.
.format_na_strs	(character or NULL) NA strings for the cells.

Value

A RowsVerticalSection object (or NULL). The details of this object should be considered an internal implementation detail.

Note

In post-processing, referential footnotes can also be added using row and column paths with fnotes_at_path<-.

See Also

analyze()

Examples

in_rows(1, 2, 3, .names = c("a", "b", "c"))
in_rows(1, 2, 3, .labels = c("a", "b", "c"))
in_rows(1, 2, 3, .names = c("a", "b", "c"), .labels = c("AAA", "BBB", "CCC"))

in_rows(.list = list(a = 1, b = 2, c = 3))
in_rows(1, 2, .list = list(3), .names = c("a", "b", "c"))

lyt <- basic_table() %>%
  split_cols_by("ARM") %>%
  analyze("AGE", afun = function(x) {
    in_rows(
      "Mean (sd)" = rcell(c(mean(x), sd(x)), format = "xx.xx (xx.xx)"),
      "Range" = rcell(range(x), format = "xx.xx - xx.xx")
    )
  })

tbl <- build_table(lyt, ex_adsl)
tbl

rtables documentation built on Sept. 30, 2024, 9:32 a.m.