Learn R Programming
pixiedust (version 0.9.4)

sprinkle_align: Sprinkle Alignment of Table Cells

Description

The alignment refers to the positioning of the text within a cell. Alignment may be given relative to the left, center, or right of a cell, and the top, middle, or bottom of the cell.

Usage

sprinkle_align(
  x,
  rows = NULL,
  cols = NULL,
  halign = NULL,
  valign = NULL,
  part = c("body", "head", "foot", "interfoot", "table"),
  fixed = FALSE,
  recycle = c("none", "rows", "cols", "columns"),
  ...
)
# S3 method for default
sprinkle_align(
  x,
  rows = NULL,
  cols = NULL,
  halign = NULL,
  valign = NULL,
  part = c("body", "head", "foot", "interfoot", "table"),
  fixed = FALSE,
  recycle = c("none", "rows", "cols", "columns"),
  ...
)
# S3 method for dust_list
sprinkle_align(
  x,
  rows = NULL,
  cols = NULL,
  halign = NULL,
  valign = 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.

halign

character One of "left", "center", or "right". Defaults to NULL, for no change to the current value.

valign

character One of "top", "middle", or "bottom". Defaults to NULL, for no change to the current value.

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 halign and valign columns in the table part.

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

  3. Casts an error if halign is not a character

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

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

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

  7. Casts an error if valign is not a character

  8. Cast an error if recycle = "none" and halign does not have length 1.

  9. Cast an error if recycle = "none" and valign does not have length 1.

  10. Cast an error if halign is not one of c("left", "center", "right")

  11. Cast an error if valign is not one of c("top", "middle", "bottom")

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