navigatr provides navigation menus and input forms.
the navigation menu allows piped data processing for hierarchical data structures. By activating menu items, operations on each item can be performed while maintaining the overall structure with attributes.
The core functions of this package are as follows,
new_nav_menu() builds a new navigation menu.
activate() accesses a menu item.new_nav_input() builds a new input form.
itemise() enters values into the form.rekey() and rekey_with() renames the key
of a menu item.You can install navigatr from CRAN.
install.packages("navigatr")You can also install the development version from GitHub.
# install.packages("devtools")
devtools::install_github("UchidaMizuki/navigatr")library(navigatr)
library(dplyr)To build a new navigation menu, give new_menu() unique
keys and a list of their corresponding values. The upper rows show the
menu items (keys on the left, value summaries on the right). By defining
pillar::obj_sum(), you can change the way the summaries are
displayed.
band <- new_nav_menu(key = c("band_members", "band_instruments"),
value = list(band_members, band_instruments))
band
#> # ☐ band_members: tibble [3 × 2]
#> # ☐ band_instruments: tibble [3 × 2]
#> #
#> # Please `activate()`.You can activate a menu item by activate(). Activating a
menu item allows you to perform operations on the active item.
activate() turns a navigatr_new_menu object
into an navigatr_nav_item object, and
deactivate() turns it back.
band <- band |>
activate(band_members) |>
filter(band == "Beatles")
band
#> # ☒ band_members: tibble [2 × 2]
#> # ☐ band_instruments: tibble [3 × 2]
#> #
#> # A tibble: 2 × 2
#> name band
#> <chr> <chr>
#> 1 John Beatles
#> 2 Paul Beatlesband <- band |>
deactivate()
band
#> # ☐ band_members: tibble [2 × 2]
#> # ☐ band_instruments: tibble [3 × 2]
#> #
#> # Please `activate()`.The rekey() function is used to change the key of an
activated menu item.
band |>
activate(band_instruments) |>
rekey("new_band_instruments")
#> # ☐ band_members: tibble [2 × 2]
#> # ☒ new_band_instruments: tibble [3 × 2]
#> #
#> # A tibble: 3 × 2
#> name plays
#> <chr> <chr>
#> 1 John guitar
#> 2 Paul bass
#> 3 Keith guitarYou can also build a nested navigation menu. To activate the items, specify multiple variables.
bands <- new_nav_menu(key = c("key1", "key2"),
value = list(band, band)) # A list of menu objects
bands |>
activate(key1, band_instruments) |>
select(name)
#> # ☒ key1: nav_menu [2]
#> # ☐ band_members: tibble [2 × 2]
#> # ☒ band_instruments: tibble [3 × 1]
#> # ☐ key2: nav_menu [2]
#> #
#> # A tibble: 3 × 1
#> name
#> <chr>
#> 1 John
#> 2 Paul
#> 3 Keithinput <- new_nav_input(key = c("key1", "key2"))
input
#> # ✖ key1: chr [0]
#> # ✖ key2: chr [0]
#> #
#> # Please `itemise()`.input |>
itemise(key1 = "value1",
key2 = "value2")
#> # ✔ key1: chr [1]
#> # ✔ key2: chr [1]
#> #
#> # Please `itemise()`.