sprinkle_na_string: Sprinkle Appearance of NA's

Description Usage Arguments Functional Requirements See Also

View source: R/sprinkle_na_string.R

Description

The appearance of NA values in a table may be dependent on the context. pixiedust uses the na_string sprinkle to guide the appearance of missing values in the table.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
sprinkle_na_string(
  x,
  rows = NULL,
  cols = NULL,
  na_string = getOption("pixie_na_string", NA),
  part = c("body", "head", "foot", "interfoot", "table"),
  fixed = FALSE,
  recycle = c("none", "rows", "cols", "columns"),
  ...
)

## Default S3 method:
sprinkle_na_string(
  x,
  rows = NULL,
  cols = NULL,
  na_string = getOption("pixie_na_string", NA),
  part = c("body", "head", "foot", "interfoot", "table"),
  fixed = FALSE,
  recycle = c("none", "rows", "cols", "columns"),
  ...
)

## S3 method for class 'dust_list'
sprinkle_na_string(
  x,
  rows = NULL,
  cols = NULL,
  na_string = getOption("pixie_na_string", NA),
  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.

na_string

character(1) A character string giving desired replacement for NA values in the selected cells.

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 na_string column in the table part.

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

  3. Casts an error if bg is not a character(1)

  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. Cast an error if recycle = "none" and na_string does not have length 1.

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


pixiedust documentation built on Jan. 16, 2021, 5:25 p.m.