avarspl: Define a subset tabulation/analysis
In rtables: Reporting Tables

AnalyzeVarSplit

R Documentation

Define a subset tabulation/analysis

Description

Define a subset tabulation/analysis

Usage

AnalyzeVarSplit(
  var,
  split_label = var,
  afun,
  defrowlab = "",
  cfun = NULL,
  cformat = NULL,
  split_format = NULL,
  split_na_str = NA_character_,
  inclNAs = FALSE,
  split_name = var,
  extra_args = list(),
  indent_mod = 0L,
  label_pos = "default",
  cvar = ""
)

AnalyzeColVarSplit(
  afun,
  defrowlab = "",
  cfun = NULL,
  cformat = NULL,
  split_format = NULL,
  split_na_str = NA_character_,
  inclNAs = FALSE,
  split_name = "",
  extra_args = list(),
  indent_mod = 0L,
  label_pos = "default",
  cvar = ""
)

AnalyzeMultiVars(
  var,
  split_label = "",
  afun,
  defrowlab = "",
  cfun = NULL,
  cformat = NULL,
  split_format = NULL,
  split_na_str = NA_character_,
  inclNAs = FALSE,
  .payload = NULL,
  split_name = NULL,
  extra_args = list(),
  indent_mod = 0L,
  child_labels = c("default", "topleft", "visible", "hidden"),
  child_names = var,
  cvar = "",
  section_div = NA_character_
)

Arguments

`var`	string, variable name
`split_label`	string. Label string to be associated with the table generated by the split. Not to be confused with labels assigned to each child (which are based on the data and type of split during tabulation).
`afun`	function. Analysis function, must take `x` or `df` as its first parameter. Can optionally take other parameters which will be populated by the tabulation framework. See Details in `analyze`.
`defrowlab`	character. Default row labels if they are not specified by the return value of `afun`
`cfun`	list/function/NULL. tabulation function(s) for creating content rows. Must accept `x` or `df` as first parameter. Must accept `labelstr` as the second argument. Can optionally accept all optional arguments accepted by analysis functions. See `analyze`.
`cformat`	format spec. Format for content rows
`split_format`	`FormatSpec`. Default format associated with the split being created.
`split_na_str`	character. NA string vector for use with `split_format`.
`inclNAs`	boolean. Should observations with NA in the `var` variable(s) be included when performing this analysis. Defaults to `FALSE`
`split_name`	string. Name associated with this split (for pathing, etc)
`extra_args`	list. Extra arguments to be passed to the tabulation function. Element position in the list corresponds to the children of this split. Named elements in the child-specific lists are ignored if they do not match a formal argument of the tabulation function.
`indent_mod`	numeric. Modifier for the default indent position for the structure created by this function(subtable, content table, or row) and all of that structure's children. Defaults to 0, which corresponds to the unmodified default behavior.
`label_pos`	character(1). Location the variable label should be displayed, Accepts `"hidden"` (default for non-analyze row splits), `"visible"`, `"topleft"`, and - for analyze splits only - `"default"`. For analyze calls, `"default"` indicates that the variable should be visible if and only if multiple variables are analyzed at the same level of nesting.
`cvar`	character(1). The variable, if any, which the content function should accept. Defaults to NA.
`.payload`	Used internally, not intended to be set by end users.
`child_labels`	string. One of `"default"`, `"visible"`, `"hidden"`. What should the display behavior be for the labels (i.e. label rows) of the children of this split. Defaults to `"default"` which flags the label row as visible only if the child has 0 content rows.
`child_names`	character. Names to be given to the sub splits contained by a compound split (typically a `AnalyzeMultiVars` split object).
`section_div`	character(1). String which should be repeated as a section divider after each group defined by this split instruction, or `NA_character_` (the default) for no section divider.