Learn R Programming
rtables (version 0.4.0)

c,SplitVector-method: combine SplitVector objects

Description

These are internal methods that are documented only to satisfy R CMD check. End users should pay no attention to this documentation.

Usage

# S4 method for SplitVector
c(x, ...)
split_rows(lyt = NULL, spl, pos, cmpnd_fun = AnalyzeMultiVars)
# S4 method for `NULL`
split_rows(lyt = NULL, spl, pos, cmpnd_fun = AnalyzeMultiVars)
# S4 method for PreDataRowLayout
split_rows(lyt = NULL, spl, pos, cmpnd_fun = AnalyzeMultiVars)
# S4 method for SplitVector
split_rows(lyt = NULL, spl, pos, cmpnd_fun = AnalyzeMultiVars)
# S4 method for PreDataTableLayouts
split_rows(lyt, spl, pos)
# S4 method for ANY
split_rows(lyt, spl, pos)
cmpnd_last_rowsplit(lyt, spl, constructor)
# S4 method for `NULL`
cmpnd_last_rowsplit(lyt, spl, constructor)
# S4 method for PreDataRowLayout
cmpnd_last_rowsplit(lyt, spl, constructor)
# S4 method for SplitVector
cmpnd_last_rowsplit(lyt, spl, constructor)
# S4 method for PreDataTableLayouts
cmpnd_last_rowsplit(lyt, spl, constructor)
# S4 method for ANY
cmpnd_last_rowsplit(lyt, spl, constructor)
split_cols(lyt = NULL, spl, pos)
# S4 method for `NULL`
split_cols(lyt = NULL, spl, pos)
# S4 method for PreDataColLayout
split_cols(lyt = NULL, spl, pos)
# S4 method for SplitVector
split_cols(lyt = NULL, spl, pos)
# S4 method for PreDataTableLayouts
split_cols(lyt = NULL, spl, pos)
# S4 method for ANY
split_cols(lyt = NULL, spl, pos)
cmpnd_last_colsplit(lyt, spl, constructor)
# S4 method for `NULL`
cmpnd_last_colsplit(lyt, spl, constructor)
# S4 method for PreDataColLayout
cmpnd_last_colsplit(lyt, spl, constructor)
# S4 method for SplitVector
cmpnd_last_colsplit(lyt, spl, constructor)
# S4 method for PreDataTableLayouts
cmpnd_last_colsplit(lyt, spl, constructor)
# S4 method for ANY
cmpnd_last_colsplit(lyt, spl, constructor)
.add_row_summary(
  lyt,
  label,
  cfun,
  child_labels = c("default", "visible", "hidden"),
  cformat = NULL,
  indent_mod = 0L,
  cvar = "",
  extra_args = list()
)
# S4 method for PreDataTableLayouts
.add_row_summary(
  lyt,
  label,
  cfun,
  child_labels = c("default", "visible", "hidden"),
  cformat = NULL,
  indent_mod = 0L,
  cvar = "",
  extra_args = list()
)
# S4 method for PreDataRowLayout
.add_row_summary(
  lyt,
  label,
  cfun,
  child_labels = c("default", "visible", "hidden"),
  cformat = NULL,
  indent_mod = 0L,
  cvar = "",
  extra_args = list()
)
# S4 method for SplitVector
.add_row_summary(
  lyt,
  label,
  cfun,
  child_labels = c("default", "visible", "hidden"),
  cformat = NULL,
  indent_mod = 0L,
  cvar = "",
  extra_args = list()
)
# S4 method for Split
.add_row_summary(
  lyt,
  label,
  cfun,
  child_labels = c("default", "visible", "hidden"),
  cformat = NULL,
  indent_mod = 0L,
  cvar = "",
  extra_args = list()
)
fix_dyncuts(spl, df)
# S4 method for Split
fix_dyncuts(spl, df)
# S4 method for VarDynCutSplit
fix_dyncuts(spl, df)
# S4 method for VTableTree
fix_dyncuts(spl, df)
# S4 method for PreDataRowLayout
fix_dyncuts(spl, df)
# S4 method for PreDataColLayout
fix_dyncuts(spl, df)
# S4 method for SplitVector
fix_dyncuts(spl, df)
# S4 method for PreDataTableLayouts
fix_dyncuts(spl, df)
summarize_rows_inner(obj, depth = 0, indent = 0)
# S4 method for TableTree
summarize_rows_inner(obj, depth = 0, indent = 0)
# S4 method for ElementaryTable
summarize_rows_inner(obj, depth = 0, indent = 0)
# S4 method for TableRow
summarize_rows_inner(obj, depth = 0, indent = 0)
# S4 method for LabelRow
summarize_rows_inner(obj, depth = 0, indent = 0)
table_structure_inner(obj, depth = 0, indent = 0, print_indent = 0)
# S4 method for TableTree
table_structure_inner(obj, depth = 0, indent = 0, print_indent = 0)
# S4 method for ElementaryTable
table_structure_inner(obj, depth = 0, indent = 0, print_indent = 0)
# S4 method for TableRow
table_structure_inner(obj, depth = 0, indent = 0, print_indent = 0)
# S4 method for LabelRow
table_structure_inner(obj, depth = 0, indent = 0, print_indent = 0)
next_rpos(obj, nested = TRUE, for_analyze = FALSE)
# S4 method for PreDataTableLayouts
next_rpos(obj, nested = TRUE, for_analyze = FALSE)
# S4 method for PreDataRowLayout
next_rpos(obj, nested = TRUE, for_analyze = FALSE)
# S4 method for ANY
next_rpos(obj, nested)
next_cpos(obj, nested = TRUE)
# S4 method for PreDataTableLayouts
next_cpos(obj, nested = TRUE)
# S4 method for PreDataColLayout
next_cpos(obj, nested = TRUE)
# S4 method for ANY
next_cpos(obj, nested = TRUE)
last_rowsplit(obj)
# S4 method for `NULL`
last_rowsplit(obj)
# S4 method for SplitVector
last_rowsplit(obj)
# S4 method for PreDataRowLayout
last_rowsplit(obj)
# S4 method for PreDataTableLayouts
last_rowsplit(obj)
rlayout(obj)
# S4 method for PreDataTableLayouts
rlayout(obj)
# S4 method for ANY
rlayout(obj)
rlayout(object) <- value
# S4 method for PreDataTableLayouts
rlayout(object) <- value
tree_pos(obj)
# S4 method for VLayoutNode
tree_pos(obj)
pos_subset(obj)
# S4 method for TreePos
pos_subset(obj)
# S4 method for VLayoutNode
pos_subset(obj)
pos_splits(obj)
# S4 method for TreePos
pos_splits(obj)
# S4 method for VLayoutNode
pos_splits(obj)
pos_splvals(obj)
# S4 method for TreePos
pos_splvals(obj)
# S4 method for VLayoutNode
pos_splvals(obj)
pos_split_labels(obj)
# S4 method for TreePos
pos_split_labels(obj)
# S4 method for VLayoutNode
pos_split_labels(obj)
split_texttype(obj)
# S4 method for VarLevelSplit
split_texttype(obj)
# S4 method for MultiVarSplit
split_texttype(obj)
# S4 method for AllSplit
split_texttype(obj)
# S4 method for RootSplit
split_texttype(obj)
# S4 method for NULLSplit
split_texttype(obj)
# S4 method for VarStaticCutSplit
split_texttype(obj)
# S4 method for VarDynCutSplit
split_texttype(obj)
# S4 method for ManualSplit
split_texttype(obj)
# S4 method for ANY
split_texttype(obj)
pos_spltypes(obj)
# S4 method for TreePos
pos_spltypes(obj)
# S4 method for VLayoutNode
pos_spltypes(obj)
pos_splval_labels(obj)
# S4 method for TreePos
pos_splval_labels(obj)
# S4 method for VLayoutNode
pos_splval_labels(obj)
spl_payload(obj)
# S4 method for Split
spl_payload(obj)
spl_payload(obj) <- value
# S4 method for Split
spl_payload(obj) <- value
spl_label_var(obj)
# S4 method for VarLevelSplit
spl_label_var(obj)
# S4 method for Split
spl_label_var(obj)
tt_labelrow(obj)
# S4 method for VTableTree
tt_labelrow(obj)
tt_labelrow(obj) <- value
# S4 method for VTableTree
tt_labelrow(obj) <- value
labelrow_visible(obj)
# S4 method for VTableTree
labelrow_visible(obj)
# S4 method for LabelRow
labelrow_visible(obj)
# S4 method for VAnalyzeSplit
labelrow_visible(obj)
labelrow_visible(obj) <- value
# S4 method for VTableTree
labelrow_visible(obj) <- value
# S4 method for LabelRow
labelrow_visible(obj) <- value
# S4 method for VAnalyzeSplit
labelrow_visible(obj) <- value
label_kids(spl)
# S4 method for Split
label_kids(spl)
label_kids(spl) <- value
# S4 method for Split,character
label_kids(spl) <- value
# S4 method for Split,logical
label_kids(spl) <- value
vis_label(spl)
# S4 method for Split
vis_label(spl)
vis_label(spl) <- value
label_position(spl)
# S4 method for Split
label_position(spl)
# S4 method for VAnalyzeSplit
label_position(spl)
label_position(spl) <- value
# S4 method for Split
label_position(spl) <- value
content_fun(obj)
# S4 method for Split
content_fun(obj)
content_fun(object) <- value
# S4 method for Split
content_fun(object) <- value
analysis_fun(obj)
# S4 method for AnalyzeVarSplit
analysis_fun(obj)
# S4 method for AnalyzeColVarSplit
analysis_fun(obj)
analysis_fun(object) <- value
# S4 method for AnalyzeVarSplit
analysis_fun(object) <- value
# S4 method for AnalyzeColVarSplit
analysis_fun(object) <- value
split_fun(obj)
# S4 method for CustomizableSplit
split_fun(obj)
# S4 method for Split
split_fun(obj)
content_extra_args(obj)
# S4 method for Split
content_extra_args(obj)
content_extra_args(object) <- value
# S4 method for Split
content_extra_args(object) <- value
content_var(obj)
# S4 method for Split
content_var(obj)
content_var(object) <- value
# S4 method for Split
content_var(object) <- value
avar_inclNAs(obj)
# S4 method for VAnalyzeSplit
avar_inclNAs(obj)
avar_inclNAs(obj) <- value
# S4 method for VAnalyzeSplit
avar_inclNAs(obj) <- value
spl_labelvar(obj)
# S4 method for VarLevelSplit
spl_labelvar(obj)
spl_child_order(obj)
# S4 method for VarLevelSplit
spl_child_order(obj)
spl_child_order(obj) <- value
# S4 method for VarLevelSplit
spl_child_order(obj) <- value
# S4 method for ManualSplit
spl_child_order(obj)
# S4 method for MultiVarSplit
spl_child_order(obj)
# S4 method for AllSplit
spl_child_order(obj)
# S4 method for VarStaticCutSplit
spl_child_order(obj)
root_spl(obj)
# S4 method for PreDataAxisLayout
root_spl(obj)
root_spl(obj) <- value
# S4 method for PreDataAxisLayout
root_spl(obj) <- value
spanned_values(obj)
# S4 method for TableRow
spanned_values(obj)
# S4 method for LabelRow
spanned_values(obj)
spanned_cells(obj)
# S4 method for TableRow
spanned_cells(obj)
# S4 method for LabelRow
spanned_cells(obj)
spanned_values(obj) <- value
# S4 method for TableRow
spanned_values(obj) <- value
# S4 method for LabelRow
spanned_values(obj) <- value
obj_format(obj)
# S4 method for ANY
obj_format(obj)
# S4 method for VTableNodeInfo
obj_format(obj)
# S4 method for Split
obj_format(obj)
obj_format(obj) <- value
# S4 method for ANY
obj_format(obj) <- value
# S4 method for VTableNodeInfo
obj_format(obj) <- value
# S4 method for Split
obj_format(obj) <- value
set_format_recursive(obj, format, override = FALSE)
# S4 method for TableRow
set_format_recursive(obj, format, override = FALSE)
# S4 method for LabelRow
set_format_recursive(obj, format, override = FALSE)
content_format(obj)
# S4 method for Split
content_format(obj)
content_format(obj) <- value
# S4 method for Split
content_format(obj) <- value
row_cspans(obj)
# S4 method for TableRow
row_cspans(obj)
# S4 method for LabelRow
row_cspans(obj)
row_cspans(obj) <- value
# S4 method for TableRow
row_cspans(obj) <- value
# S4 method for LabelRow
row_cspans(obj) <- value
cell_cspan(obj)
# S4 method for CellValue
cell_cspan(obj)
cell_cspan(obj) <- value
# S4 method for CellValue
cell_cspan(obj) <- value
tt_level(obj)
# S4 method for VNodeInfo
tt_level(obj)
tt_level(obj) <- value
# S4 method for VNodeInfo
tt_level(obj) <- value
# S4 method for VTableTree
tt_level(obj) <- value
indent_mod(obj)
# S4 method for Split
indent_mod(obj)
# S4 method for VTableNodeInfo
indent_mod(obj)
# S4 method for ANY
indent_mod(obj)
# S4 method for RowsVerticalSection
indent_mod(obj)
indent_mod(obj) <- value
# S4 method for Split
indent_mod(obj) <- value
# S4 method for VTableNodeInfo
indent_mod(obj) <- value
content_indent_mod(obj)
# S4 method for Split
content_indent_mod(obj)
# S4 method for VTableNodeInfo
content_indent_mod(obj)
content_indent_mod(obj) <- value
# S4 method for Split
content_indent_mod(obj) <- value
# S4 method for VTableNodeInfo
content_indent_mod(obj) <- value
rawvalues(obj)
# S4 method for ValueWrapper
rawvalues(obj)
# S4 method for LevelComboSplitValue
rawvalues(obj)
# S4 method for list
rawvalues(obj)
# S4 method for ANY
rawvalues(obj)
# S4 method for CellValue
rawvalues(obj)
# S4 method for TreePos
rawvalues(obj)
# S4 method for RowsVerticalSection
rawvalues(obj)
value_names(obj)
# S4 method for ANY
value_names(obj)
# S4 method for TreePos
value_names(obj)
# S4 method for list
value_names(obj)
# S4 method for ValueWrapper
value_names(obj)
# S4 method for LevelComboSplitValue
value_names(obj)
# S4 method for RowsVerticalSection
value_names(obj)
value_labels(obj)
# S4 method for ANY
value_labels(obj)
# S4 method for TreePos
value_labels(obj)
# S4 method for list
value_labels(obj)
# S4 method for RowsVerticalSection
value_labels(obj)
# S4 method for ValueWrapper
value_labels(obj)
# S4 method for LevelComboSplitValue
value_labels(obj)
# S4 method for MultiVarSplit
value_labels(obj)
spl_varlabels(obj)
# S4 method for MultiVarSplit
spl_varlabels(obj)
spl_varlabels(object) <- value
# S4 method for MultiVarSplit
spl_varlabels(object) <- value
splv_extra(obj)
# S4 method for SplitValue
splv_extra(obj)
splv_extra(obj) <- value
# S4 method for SplitValue
splv_extra(obj) <- value
split_exargs(obj)
# S4 method for Split
split_exargs(obj)
split_exargs(obj) <- value
# S4 method for Split
split_exargs(obj) <- value
clayout_splits(obj)
# S4 method for LayoutColTree
clayout_splits(obj)
# S4 method for LayoutColLeaf
clayout_splits(obj)
# S4 method for VTableNodeInfo
clayout_splits(obj)
col_extra_args(obj, df = NULL)
# S4 method for InstantiatedColumnInfo
col_extra_args(obj, df = NULL)
# S4 method for PreDataTableLayouts
col_extra_args(obj, df = NULL)
# S4 method for PreDataColLayout
col_extra_args(obj, df = NULL)
# S4 method for LayoutColTree
col_extra_args(obj, df = NULL)
# S4 method for LayoutColLeaf
col_extra_args(obj, df = NULL)
disp_ccounts(obj)
# S4 method for VTableTree
disp_ccounts(obj)
# S4 method for InstantiatedColumnInfo
disp_ccounts(obj)
# S4 method for PreDataTableLayouts
disp_ccounts(obj)
# S4 method for PreDataColLayout
disp_ccounts(obj)
disp_ccounts(obj) <- value
# S4 method for VTableTree
disp_ccounts(obj) <- value
# S4 method for InstantiatedColumnInfo
disp_ccounts(obj) <- value
# S4 method for PreDataColLayout
disp_ccounts(obj) <- value
# S4 method for LayoutColTree
disp_ccounts(obj) <- value
# S4 method for PreDataTableLayouts
disp_ccounts(obj) <- value
colcount_format(obj)
# S4 method for InstantiatedColumnInfo
colcount_format(obj)
# S4 method for VTableNodeInfo
colcount_format(obj)
# S4 method for PreDataColLayout
colcount_format(obj)
# S4 method for PreDataTableLayouts
colcount_format(obj)
colcount_format(obj) <- value
# S4 method for InstantiatedColumnInfo
colcount_format(obj) <- value
# S4 method for VTableNodeInfo
colcount_format(obj) <- value
# S4 method for PreDataColLayout
colcount_format(obj) <- value
# S4 method for PreDataTableLayouts
colcount_format(obj) <- value
spl_cuts(obj)
# S4 method for VarStaticCutSplit
spl_cuts(obj)
spl_cutlabels(obj)
# S4 method for VarStaticCutSplit
spl_cutlabels(obj)
spl_cutfun(obj)
# S4 method for VarDynCutSplit
spl_cutfun(obj)
spl_cutlabelfun(obj)
# S4 method for VarDynCutSplit
spl_cutlabelfun(obj)
spl_is_cmlcuts(obj)
# S4 method for VarDynCutSplit
spl_is_cmlcuts(obj)
spl_varnames(obj)
# S4 method for MultiVarSplit
spl_varnames(obj)
spl_varnames(object) <- value
# S4 method for MultiVarSplit
spl_varnames(object) <- value
# S4 method for VTableTree
print(x, ...)
# S4 method for VTableTree
show(object)

Arguments

x

The object.

...

Splits or SplitVector objects

lyt

layout object pre-data used for tabulation

spl

Split. The split.

pos

numeric(1). Intended for internal use.

cmpnd_fun

function. Intended for internal use.

constructor

function.

label

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

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.

child_labels

string. One of "default", "visible", "hidden". What should the display behavior be for the labels (ie 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.

cformat

format spec. Format for content rows

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.

cvar

character(1). The variable, if any, which the content function should accept. Defaults to NA.

extra_args

list. Extra arguments to be passed to the tabulation function. Element position in thte 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 ttabulation function.

df

dataset (data.frame or tibble)

obj

The object.

depth

depth in tree

indent

indent

print_indent

indent for print

nested

boolean, Add this as a new top-level split (defining a new subtable directly under root). Defaults to FALSE

for_analyze

logical(1).

object

The object to modify in-place

value

The new value

format

FormatSpec. Format associated with this split. Formats can be declared via strings ("xx.x") or function. In cases such as analyze calls, they can character vectors or lists of functions.

override

logical(1).

Value

Various, but should be considered implementation details.

Examples

Run this code
# NOT RUN {
library(dplyr)

iris2 <- iris %>%
  group_by(Species) %>%
  mutate(group = as.factor(rep_len(c("a", "b"), length.out = n()))) %>%
  ungroup()

l <- basic_table() %>%
  split_cols_by("Species") %>%
  split_cols_by("group") %>%
  analyze(c("Sepal.Length", "Petal.Width"), afun = list_wrap_x(summary) , format = "xx.xx")

tbl <- build_table(l, iris2)

summarize_rows(tbl)
# }

Run the code above in your browser using DataLab