i2dash (version 0.2.4)

i2dashboard-class: The i2dashboard S4 class.

Description

The i2dashboard S4 class provides main functionality of the package. Besides global properties such as the dashboard title, author and theme, an instance of the i2dashboard class also stores individual dashboard pages and the navigation menu, as well as all components that make up the content of individual pages. A new instance can be created using the i2dashboard function.

Usage

# S4 method for i2dashboard
initialize(.Object, ...)
# S4 method for i2dashboard
show(object)
i2dashboard(...)

Value

'i2dashboard()' returns an i2dashboard object with a default title, theme, and an empty 'default' page.

'show()' returns text, describing the structure of the i2dashboard object.

Arguments

.Object

An object of class i2dashboard.

...

Named slots of the i2dashboard object.

object

An i2dashboard class object.

Slots

title

The dashboards title (default 'i2dashboard').

author

The author of the dashboard.

interactive

If a 'shiny'-based report should be created (default 'FALSE').

theme

The theme of the dashboard (see the documentation of 'flexdashboard' for available themes) (default 'yeti').

datadir

Path to the directory, where report data is stored (default 'tempdir()').

pages

A list of dashboard pages.

sidebar

Content of the global sidebar

colormaps

A named list with color mappings.

source

Either a logical value describing whether the source code should be embeded through an item in the navigation bar or a link to a URL where the source code can be found online.

share

A vector with any number of the following services: 'facebook', 'twitter', 'google-plus', 'linkedin', and 'pinterest'. You can also specify “menu” to provide a generic sharing drop-down menu that includes all of the services.

navbar

A list of links in the navigation bar (see the documentation of 'flexdashboard').

Examples

# \donttest{
dashboard <- i2dashboard()
dashboard <- i2dashboard(
    title = "Dashboard title",
    author = "John Doe",
    interactive = TRUE,
    theme = "cosmo",
    datadir = "path/to/workdir",
    source = "embed"
)
# inspect dashboard:
show(dashboard)
dashboard
# }