validateState: Validate State Parameters

In trelliscope: Create and Navigate Large Multi-Panel Visual Displays

Description

Validate state parameters for a Trelliscope display

Usage

validateState(x, displayObj = NULL, checkDisplay = TRUE)

Arguments

x	a list of state parameter settings (such as layout, sorting, filtering, etc.) to use when the display is viewed (see details)
displayObj	a display object to validate against (if not provided and checkDisplay is TRUE, it will be fetched based on x)
checkDisplay	should the state be checked against a display (to make sure fields match, etc.) or should it simply be checked for structure?

Value

a modified state parameter list that is valid, an object of class "cogState"

Note

See stateSpec for details on how to specify state.

See Also

view, cogDisplayHref

Examples

state <- stateSpec(
  name = "my_display",
  sort = list(state = "desc", county = "asc"),
  filter = list(
    county = list(regex = "Ben"),
    state = list(select = c("OR", "WA")),
    meanList = list(from = 50, to = 150)
  ),
  layout = list(nrow = 2, ncol = 4),
  labels = c("county", "state")
)

state <- validateState(state, checkDisplay = FALSE)

makeStateHash(state)

Example output

Loading required package: datadr
Note: trelliscope will eventually be superseded by trelliscopejs: https://github.com/hafen/trelliscopejs
[1] "name=my_display&group=common&layout=nrow:2,ncol:4,arrange:row&sort=state:desc,county:asc&filter=county:(regex:Ben),state:(select:OR;WA),meanList:(from:50;to:150)&labels=county,state"

trelliscope documentation built on Sept. 20, 2017, 5:04 p.m.