compareOptions: Options for comparison mode

In rte-antares-rpackage/manipulateWidget: Add Even More Interactivity to Interactive Charts

Description

This function generates a list of options that are used by manipulateWidget to compare multiple charts.

Usage

compareOptions(ncharts = NULL, nrow = NULL, ncol = NULL, allowCompare = TRUE)

Arguments

ncharts	Number of charts to generate.
nrow	Number of rows. If NULL, the function tries to pick the best number of rows given the number of charts and columns.
ncol	Number of columns. If NULL, the function tries to pick the best number of columns given the number of charts and rows.
allowCompare	If TRUE (the default), then the user can use the UI to add or remove charts and choose which variables to compare

Value

List of options

Examples

if (require(dygraphs)) {

  mydata <- data.frame(
    year = 2000+1:100,
    series1 = rnorm(100),
    series2 = rnorm(100),
    series3 = rnorm(100)
  )
  manipulateWidget(
    dygraph(mydata[range[1]:range[2] - 2000, c("year", series)], main = title),
    range = mwSlider(2001, 2100, c(2001, 2100)),
    series = mwSelect(c("series1", "series2", "series3")),
    title = mwText("Fictive time series"),
    .compare = list(title = NULL, series = NULL),
    .compareOpts = compareOptions(ncharts = 4)
  )

  manipulateWidget(
    dygraph(mydata[range[1]:range[2] - 2000, c("year", series)], main = title),
    range = mwSlider(2001, 2100, c(2001, 2100)),
    series = mwSelect(c("series1", "series2", "series3")),
    title = mwText("Fictive time series"),
    .compare = list(title = NULL, series = NULL),
    .compareOpts = compareOptions(ncharts = 3, nrow = 3)
  )
}

rte-antares-rpackage/manipulateWidget documentation built on Oct. 5, 2021, 8:20 p.m.