insight: color_if – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

color_if

Color-formatting for data columns based on condition

Description

Convenient function that formats columns in data frames with color codes, where the color is chosen based on certain conditions. Columns are then printed in color in the console.

Usage

color_if(
  x,
  columns,
  predicate = `>`,
  value = 0,
  color_if = "green",
  color_else = "red",
  digits = 2
)

colour_if(
  x,
  columns,
  predicate = `>`,
  value = 0,
  colour_if = "green",
  colour_else = "red",
  digits = 2
)

Arguments

`x`	A data frame
`columns`	Character vector with column names of `x` that should be formatted.
`predicate`	A function that takes `columns` and `value` as input and which should return `TRUE` or `FALSE`, based on if the condition (in comparison with `value`) is met.
`value`	The comparator. May be used in conjunction with `predicate` to quickly set up a function which compares elements in `colums` to `value`. May be ignored when `predicate` is a function that internally computes other comparisons. See 'Examples'.
`color_if, colour_if`	Character vector, indicating the color code used to format values in `x` that meet the condition of `predicate` and `value`. May be one of `"red"`, `"yellow"`, `"green"`, `"blue"`, `"violet"`, `"cyan"` or `"grey"`. Formatting is also possible with `"bold"` or `"italic"`.
`color_else, colour_else`	See `color_if`, but only for conditions that are not met.
`digits`	Digits for rounded values.

Details

The predicate-function simply works like this: which(predicate(x[, columns], value))

Value

The .

Examples

# all values in Sepal.Length larger than 5 in green, all remaining in red
x <- color_if(iris[1:10, ], columns = "Sepal.Length", predicate = `>`, value = 5)
x
cat(x$Sepal.Length)

# all levels "setosa" in Species in green, all remaining in red
x <- color_if(iris, columns = "Species", predicate = `==`, value = "setosa")
cat(x$Species)

# own function, argument "value" not needed here
p <- function(x, y) {
  x >= 4.9 & x <= 5.1
}
# all values in Sepal.Length between 4.9 and 5.1 in green, all remaining in red
x <- color_if(iris[1:10, ], columns = "Sepal.Length", predicate = p)
cat(x$Sepal.Length)

insight

Easy Access to Model Information for Various Model Objects

v0.14.0

GPL-3

Authors

Daniel Lüdecke [aut, cre] (<https://orcid.org/0000-0002-8895-3206>, @strengejacke), Dominique Makowski [aut, ctb] (<https://orcid.org/0000-0001-5375-9967>, @Dom_Makowski), Indrajeet Patil [aut, ctb] (<https://orcid.org/0000-0003-1995-6531>, @patilindrajeets), Philip Waggoner [aut, ctb] (<https://orcid.org/0000-0002-7825-7573>), Mattan S. Ben-Shachar [aut, ctb] (<https://orcid.org/0000-0002-4287-4801>), Brenton M. Wiernik [aut] (<https://orcid.org/0000-0001-9560-6336>, @bmwiernik)

Initial release