Skip to contents

navigatr

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,

Installation

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")

Examples

Build a navigation menu

To create a new navigation menu, give new_menu() unique keys and a list of their corresponding values. The top rows show the menu items (keys on the left, value summaries on the right). The description argument allows you to add descriptions to the menu items (optional).

band <- new_nav_menu(
  key = c("band_members", "band_instruments"),
  value = list(
    band_members, 
    band_instruments
  ),
  description = c(
    "A data frame of band members",
    "A data frame of band instruments"
  )
)
band
#> # ☐ band_members:     A data frame of band members
#> # ☐ band_instruments: A data frame of band instruments
#> # 
#> # 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:     A data frame of band members
#> # ☐ band_instruments: A data frame of band instruments
#> # 
#> # A tibble: 2 × 2
#>   name  band   
#> * <chr> <chr>  
#> 1 John  Beatles
#> 2 Paul  Beatles
band <- band |> 
  deactivate()
band
#> # ☐ band_members:     A data frame of band members
#> # ☐ band_instruments: A data frame of band instruments
#> # 
#> # 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:         A data frame of band members
#> # ☒ new_band_instruments: A data frame of band instruments
#> # 
#> # A tibble: 3 × 2
#>   name  plays 
#> * <chr> <chr> 
#> 1 John  guitar
#> 2 Paul  bass  
#> 3 Keith guitar

You 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:     A data frame of band members
#> #   ☒ band_instruments: A data frame of band instruments
#> # ☐ key2: nav_menu [2]
#> # 
#> # A tibble: 3 × 1
#>   name 
#> * <chr>
#> 1 John 
#> 2 Paul 
#> 3 Keith

Build a input form 

input <- 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()`.