Skip to contents

Set or Get Table Layout

Source: R/table_add.R
set_layout.Rd

Add and modify (set_*) or retrieve (get_*) presentation layout for a procr_table object. Layout includes which subtables to show and their arrangement, which is trivial in case of one subtable but highly relevant once multiple subtables are combined and presented together.

Usage

set_layout(
  tab,
  ...,
  show,
  direction = NULL,
  arrangement = NULL,
  separator = FALSE
)

get_layout(tab, slot = NULL)

Arguments

tab

A procr_table object.

...

Not used for values, forces later arguments to bind by name.

show

Named character vector of matrices to show. Values are matrices, names are the subtable where they are located.

direction

To be added.

arrangement

To be added.

separator

To be added.

slot

One of the abovementioned metadata slots if a specific one should be extracted or NULL (default) to retrieve all metadata as a list.

Value

set_* returns the modified procr_table object with updated layout. Existing layout values are preserved unless explicitly overwritten. get_* returns the specified layout slot or all layout as a list.