Skip to contents

Baseline scenario

These functions are the core features you need to start using the framework.

Shiny module server

The main component of the package.

kitems()
Kitems Module Server

Shiny module UI widgets

The UI functions to include into your app.

Admin

The functions to perform admin tasks.

admin()
Admin Console

Demo

Function to list and launch the demo apps.

runExample()
Run Shiny Demo Apps

Advanced scenarios

These helper functions can be used to create events to pass to the module server reactive arguments.

filter_event()
Filter Event
trigger_event()
Trigger Event

Behind the scene

These functions are made available (exported) for advanced users who would like to go beyond the usage of the module server.

Data governance

The functions related to data model and config management.

design()
Build YAML Config
extend()
Extend Item
amend()
Amend Attribute
shrink()
Shrink Config

Behaviors

The functions related to attribute behavior management.

skip() include() skipped() included()
Skip Behavior Grammar
refresh() freeze() refreshed() frozen()
Refresh Behavior Grammar
hide() display() hidden() displayed()
Display Behavior Grammar
organize() organized()
Sort Items Grammar

Workflows

The functions related to item workflows.

default()
Default Value(s)
as_default()
Turn Item Into Default Value(s)
form()
Item Form
dialog()
Item Modal Dialog(s)
extract()
Input Values
prepare()
Prepare Values
validate()
Validate Value(s)
compute()
Attribute Values
insert()
Insert Item(s)
update()
Update Item(s)
delete()
Delete Item(s)
reveal()
Reveal Items
decorate()
Decorate Item Columns
adjust()
Sort Items
yaml_to_dm()
Config List To Table
item_load()
Load Items
item_save()
Save Items

Admin

The functions related to advanced admin tasks.

backup()
Backup Files
restore()
Restore Files
check()
Check Integrity
enforce()
Item Migration
dm_to_yaml()
Data Model To YAML
dm_migrate()
Data Model Migration
items() experimental
Get Items

Helpers

These functions are helpers used by the module server.

name()
Kitems Names
attribute_input()
Attribute Input
has_date_attribute()
Has Date
is_truthy()
Truthy Value