highlight: Highlight cells in data frame

Description Usage Arguments Value

View source: R/highlight.R

Description

Splits data frame by some columns, determines ordering of certain values in column “which” and emphasizes the best values visually.

Usage

1
2
highlight(x, by, which, order.fun = "min",
  highlight.fun = tblutils::baseLaTeXHighlighter, ...)

Arguments

x

[data.frame]
Data frame.

by

[character]
Column names used for splitting the data frame. Highlighting is performed for each split seperately.

which

[character(1)]
Column name of the column which contains the values we want to highlight.

order.fun

[function(x, ...)]
#FIXME: either function or character(1) Function used to determine numeric ordering of the values x[[which]]. This function needs to return an integer vector of the same length as the input vector. Semantic: the lower an ordering value the better.

highlight.fun

[function]
The function that does the highlight magic. It expects at least . a vector of numeric values values and a vector of corresponding order values ordering. See baseLaTeXHighlighter for a flexible highlighter function.

...

[any]
Further parameters passed down to highlight.fun.

Value

[data.frame]


jakobbossek/tblutils documentation built on March 13, 2021, 12:47 p.m.