i2dashboard-pages: Methods to add and remove pages of an i2dashboard object.

Description Usage Arguments Value Examples

Description

'add_page()' creates a page and adds it to the i2dashboard object. 'remove_page()' removes a page from the i2dashboard object.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
add_page(dashboard, ...)

remove_page(dashboard, page)

## S4 method for signature 'i2dashboard'
add_page(
  dashboard,
  page,
  title,
  layout = "default",
  menu = NULL,
  sidebar = NULL,
  ...
)

## S4 method for signature 'i2dashboard'
remove_page(dashboard, page)

Arguments

dashboard

A i2dashboard.

...

Additional arguments.

page

The name of the page to be added or removed.

title

The title of the page to be added.

layout

The page layout (see below).

menu

The name of the menu, under which the page should appear.

sidebar

A Markdown string. Preferably, use the function 'add_to_sidebar()'.

Value

Returns the i2dashboard object with a modified 'pages' slot.

Examples

1
2
3
4
5
6
i2dashboard() %>%
     add_page(page="page1",
         title="Page Title",
         layout = "2x2_grid",
         menu="Menu A") -> dashboard
dashboard %<>% remove_page(page="page1")

loosolab/i2dash documentation built on April 8, 2021, 12:41 a.m.