crunch: makeDimTransform – R documentation

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

makeDimTransform

Helper for creating slide dimension transformations for dashboards and exports

Description

When displayed in a Crunch Dashboard or exported, crunch slides can have transformations that customize their display. This is a helper to form the correct data structure for the functions newSlide() for setting the transformation directly. For more details see the API documentation

Usage

makeDimTransform(
  colors = NULL,
  hide = NULL,
  rename = NULL,
  order = NULL,
  name = NULL,
  description = NULL,
  ...
)

Arguments

`colors`	A crunch `AnalyticPalettes` (`palettes()`) or a vector of color RGB hex color codes that will be used for the color of graphs in the dashboard (used in the order of appearance of categories/subvariables).
`hide`	A vector of category names/ids or subvariable names/aliases to hide from display
`rename`	A named vector of category names/ids or subvariable names/aliases to override their default values
`order`	A vector of category names/ids or subvariable names/aliases to override the default ordering of the dimension.
`name`	A name for the dimension, overrides the variable's name
`description`	A description for the dimension, overrides the variable's description
`...`	Other arguments, passed directly to the API for future expansion

Examples

## Not run: 
# Hiding an element
transforms(slide) <- list(rows_dimension = makeDimTransform(hide = "Neutral"))

# Using an existing saved palette
transforms(slide) <- list(rows_dimension = makeDimTransform(
    colors = defaultPalette(ds)
))

# Setting specific colors
transform(slide) <- list(rows_dimension = makeDimTransform(
     colors = c("#af8dc3", "#f7f7f7", "#7fbf7b")
))

# Reordering & renaming elements
transforms(slide) <- list(
     rows_dimension = makeDimTransform(
         rename = c("V. Good" = "Very Good", "V. Bad" = "Very Bad"),
         order = 5:1
     ),
     columns_dimension = makeDimTransform(order = c("Brand X", "Brand A", "Brand B"))
)

## End(Not run)

crunch

Crunch.io Data Tools

v1.28.0

LGPL (>= 3)

Authors

Greg Freedman Ellis [aut, cre], Jonathan Keane [aut], Mike Malecki [aut], Neal Richardson [aut], Gordon Shotwell [aut]

Initial release