sprinkle_merge {pixiedust}

Sprinkle Table Cells to Merge

Description

Merging cells creates more space for values to be displayed without disrupting the appearance of other cells in the same row or column. The downside is that the content from only one of the cells in the merge range will be displayed.

Usage

sprinkle_merge(
  x,
  rows = NULL,
  cols = NULL,
  merge = FALSE,
  merge_rowval = NULL,
  merge_colval = NULL,
  part = c("body", "head", "foot", "interfoot", "table"),
  fixed = FALSE,
  recycle = c("none", "rows", "cols", "columns"),
  ...
)

## Default S3 method:
sprinkle_merge(
  x,
  rows = NULL,
  cols = NULL,
  merge = FALSE,
  merge_rowval = NULL,
  merge_colval = NULL,
  part = c("body", "head", "foot", "interfoot", "table"),
  fixed = FALSE,
  recycle = c("none", "rows", "cols", "columns"),
  ...
)

## S3 method for class 'dust_list'
sprinkle_merge(
  x,
  rows = NULL,
  cols = NULL,
  merge = FALSE,
  merge_rowval = NULL,
  merge_colval = NULL,
  part = c("body", "head", "foot", "interfoot", "table"),
  fixed = FALSE,
  recycle = c("none", "rows", "cols", "columns"),
  ...
)

Arguments

x

An object of class dust

rows

Either a numeric vector of rows in the tabular object to be modified or an object of class call. When a call, generated by quote(expression), the expression resolves to a logical vector the same length as the number of rows in the table. Sprinkles are applied to where the expression resolves to TRUE.

cols

Either a numeric vector of columns in the tabular object to be modified, or a character vector of column names. A mixture of character and numeric indices is permissible.

merge

logical Defaults to FALSE, prompting no merging action.

merge_rowval

The row position of the cell whose content will be displayed. Defaults to the minimum of rows.

merge_colval

The column position of the cell whose content will be displayed. Deafults to the minimum of cols.

part

A character string denoting which part of the table to modify.

fixed

logical(1) indicating if the values in rows and cols should be read as fixed coordinate pairs. By default, sprinkles are applied at the intersection of rows and cols, meaning that the arguments do not have to share the same length. When fixed = TRUE, they must share the same length.

recycle

A character one that determines how sprinkles are managed when the sprinkle input doesn't match the length of the region to be sprinkled. By default, recycling is turned off. Recycling may be performed across rows first (left to right, top to bottom), or down columns first (top to bottom, left to right).

...

Additional arguments to pass to other methods. Currently ignored.

Functional Requirements

1. Correctly reassigns the appropriate elements of merge, merge_rowval and merge_colval columns in the table part.

2. Casts an error if x is not a dust object.

3. Casts an error if merge is not a logical(1)

4. Casts an error if merge_rowval is not a numeric(1)

5. Casts an error if merge_colval is not a numeric(1)

6. Casts an error if part is not one of "body", "head", "foot", or "interfoot"

7. Casts an error if fixed is not a logical(1)

8. Casts an error if recycle is not one of "none", "rows", or "cols"

The functional behavior of the fixed and recycle arguments is not tested for this function. It is tested and validated in the tests for index_to_sprinkle.

See Also

sprinkle, index_to_sprinkle