rtables (version 0.6.6)

gen_args: General Argument Conventions

Description

General Argument Conventions

Usage

gen_args(
  df,
  alt_counts_df,
  spl,
  pos,
  tt,
  tr,
  verbose,
  colwidths,
  obj,
  x,
  value,
  object,
  path,
  label,
  label_pos,
  cvar,
  topleft,
  page_prefix,
  hsep,
  indent_size,
  section_div,
  na_str,
  inset,
  table_inset,
  ...
)

Value

NULL (this is an argument template dummy function)

Arguments

df

dataset (data.frame or tibble)

alt_counts_df

dataset (data.frame or tibble). Alternative full data the rtables framework will use (only) when calculating column counts.

spl

A Split object defining a partitioning or analysis/tabulation of the data.

pos

numeric. Which top-level set of nested splits should the new layout feature be added to. Defaults to the current

tt

TableTree (or related class). A TableTree object representing a populated table.

tr

TableRow (or related class). A TableRow object representing a single row within a populated table.

verbose

logical(1). Should extra debugging messages be shown. Defaults to FALSE.

colwidths

numeric vector. Column widths for use with vertical pagination.

obj

ANY. The object for the accessor to access or modify

x

An object

value

The new value

object

The object to modify in-place

path

character. A vector path for a position within the structure of a tabletree. Each element represents a subsequent choice amongst the children of the previous choice.

label

character(1). A label (not to be confused with the name) for the object/structure.

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.

topleft

character. Override values for the "top left" material to be displayed during printing.

page_prefix

character(1). Prefix, to be appended with the split value, when forcing pagination between the children of this split/table

hsep

character(1). Set of character(s) to be repeated as the separator between the header and body of the table when rendered as text. Defaults to a connected horizontal line (unicode 2014) in locals that use a UTF charset, and to - elsewhere (with a once per session warning). See formatters::set_default_hsep() for further information.

indent_size

numeric(1). Number of spaces to use per indent level. Defaults to 2

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.

na_str

character(1). String that should be displayed when the value of x is missing. Defaults to "NA".

inset

numeric(1). Number of spaces to inset the table header, table body, referential footnotes, and main_footer, as compared to alignment of title, subtitle, and provenance footer. Defaults to 0 (no inset).

table_inset

numeric(1). Number of spaces to inset the table header, table body, referential footnotes, and main_footer, as compared to alignment of title, subtitle, and provenance footer. Defaults to 0 (no inset).

...

Passed on to methods or tabulation functions.

See Also

Other conventions: compat_args(), constr_args(), lyt_args(), sf_args()