Skip to contents

Column information/structure accessors

Source: R/tree_accessors.R
col_accessors.Rd

Column information/structure accessors

Usage

clayout(obj)

# S4 method for VTableNodeInfo
clayout(obj)

# S4 method for PreDataTableLayouts
clayout(obj)

# S4 method for ANY
clayout(obj)

clayout(object) <- value

# S4 method for PreDataTableLayouts
clayout(object) <- value

col_info(obj)

# S4 method for VTableNodeInfo
col_info(obj)

col_info(obj) <- value

# S4 method for TableRow
col_info(obj) <- value

# S4 method for ElementaryTable
col_info(obj) <- value

# S4 method for TableTree
col_info(obj) <- value

coltree(
  obj,
  df = NULL,
  rtpos = TreePos(),
  alt_counts_df = df,
  ccount_format = "(N=xx)"
)

# S4 method for InstantiatedColumnInfo
coltree(
  obj,
  df = NULL,
  rtpos = TreePos(),
  alt_counts_df = df,
  ccount_format = "(N=xx)"
)

# S4 method for PreDataTableLayouts
coltree(
  obj,
  df = NULL,
  rtpos = TreePos(),
  alt_counts_df = df,
  ccount_format = "(N=xx)"
)

# S4 method for PreDataColLayout
coltree(
  obj,
  df = NULL,
  rtpos = TreePos(),
  alt_counts_df = df,
  ccount_format = "(N=xx)"
)

# S4 method for LayoutColTree
coltree(
  obj,
  df = NULL,
  rtpos = TreePos(),
  alt_counts_df = df,
  ccount_format = "(N=xx)"
)

# S4 method for VTableTree
coltree(
  obj,
  df = NULL,
  rtpos = TreePos(),
  alt_counts_df = df,
  ccount_format = "(N=xx)"
)

# S4 method for TableRow
coltree(
  obj,
  df = NULL,
  rtpos = TreePos(),
  alt_counts_df = df,
  ccount_format = "(N=xx)"
)

col_exprs(obj, df = NULL)

# S4 method for PreDataTableLayouts
col_exprs(obj, df = NULL)

# S4 method for PreDataColLayout
col_exprs(obj, df = NULL)

# S4 method for InstantiatedColumnInfo
col_exprs(obj, df = NULL)

col_counts(obj, path = NULL)

# S4 method for InstantiatedColumnInfo
col_counts(obj, path = NULL)

# S4 method for VTableNodeInfo
col_counts(obj, path = NULL)

col_counts(obj, path = NULL) <- value

# S4 method for InstantiatedColumnInfo
col_counts(obj, path = NULL) <- value

# S4 method for VTableNodeInfo
col_counts(obj, path = NULL) <- value

col_total(obj)

# S4 method for InstantiatedColumnInfo
col_total(obj)

# S4 method for VTableNodeInfo
col_total(obj)

col_total(obj) <- value

# S4 method for InstantiatedColumnInfo
col_total(obj) <- value

# S4 method for VTableNodeInfo
col_total(obj) <- value

Arguments

obj

(ANY)
the object for the accessor to access or modify.

object

(ANY)
the object to modify in place.

value

(ANY)
the new value.

df

(data.frame or NULL)
data to use if the column information is being generated from a pre-data layout object.

rtpos

(TreePos)
root position.

alt_counts_df

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

ccount_format

(FormatSpec)
The format to be used by default for column counts throughout this column tree (i.e. if not overridden by a more specific format specification).

path

(character or NULL)
col_counts accessor and setter only. Path (in column structure).

Value

A LayoutColTree object.

Returns various information about columns, depending on the accessor used.

See also

facet_colcount()