new_nav_menu: Build a new menu

In navigatr: Navigation Menu for Pipe-Friendly Data Processing

Build a new menu

Description

To build a new menu, give new_nav_menu() unique keys and a list of their corresponding values. Each line shows the menu items (keys on the left, value summaries on the right). The summaries are pillar::obj_sum outputs, so you can change the printing methods. Each menu item can be accessed by activate().

Usage

new_nav_menu(
  key = character(),
  value = list(data.frame()),
  attrs = NULL,
  ...,
  class = character()
)

Arguments

key	A unique character vector.
value	A list of values corresponding to the keys.
attrs	A data frame for additional attributes of items (an empty data frame by default). When an item becomes active, the attrs will be added to its attributes.
...	Additional arguments passed to vctrs::new_data_frame().
class	A character vector of subclasses passed to vctrs::new_data_frame().

Value

A navigatr_nav_menu object, a subclass of class data.frame.

See Also

activate()

Examples

library(dplyr)

band <- new_nav_menu(key = c("band_members", "band_instruments"),
                     value = list(band_members, band_instruments))
band

# You can also build a nested menu
bands <- new_nav_menu(key = c("key1", "key2"),
                      value = list(band, band))
bands

navigatr documentation built on Nov. 20, 2022, 9:07 a.m.