KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agent #developer-tools #codex #typescript #cli #deepseek-harness #claude-code #ai-agents #mcp #rust

tickle

★ 131 Open GitHub ↗

Easily create UIs in base R

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# tickle <img src="man/figures/logo-tickle.png" align="right" width="230"/>

![](https://img.shields.io/badge/cool-useless-green.svg)
[![R-CMD-check](https://github.com/coolbutuseless/tickle/workflows/R-CMD-check/badge.svg)](https://github.com/coolbutuseless/tickle/actions)

`{tickle}` is a package for creating UIs in base R.

This is an **opinionated abstraction** over the base R package
`{tcltk}`.

This package aims to provide:

-   a **simplified** UI creation process similar to `shiny`.
-   a **modern-looking** visual default.
-   **more documentation** to help create common UI elements without
    resorting to the online tcl/tk documentation.
-   a way to still access the low-level tcl/tk structures in order to
    achieve complex effects and customisation.

## What’s in the box

-   An array of `tic_*()` functions for nested creation of a UI
    specification.
-   `render_ui()` to render a UI specification into a window onscreen.
-   `reactive_*()` to create reactive values used to transfer values
    between the UI and R
-   `canvas_*()` functions to do some simple drawing an manipulation on
    canvas widgets.

## Overview

-   Create reactive variables (with `reactive_*()`) in order to pass
    values between R and the UI. e.g. the value of the slider, or the
    text in a text entry box.
-   Define callback functions that are called, say, when a button is
    pressed.
-   Create a UI specification by nesting containers and widgets with
    `tic_*()` calls. This specification can include
    -   binding callback functions to particular events like mouse
        buttons or key presses (`bind` argument)
    -   controlling how widgets are packed within their parent container
        (`pack` argument)
-   Render the UI to an actual object on the screen with `render_ui()`
-   The object returned by `render_ui()` can be ignored by beginners.
    For intermediate/advanced users, this object is a nested list of
    `tclObj` objects representing the UI components, and these can be
    further manipulated with `{tcltk}` to finesse and configure the UI.

## Installation

You can install from [GitHub](https://github.com/coolbutuseless/tickle)
with:

``` r
# install.package('remotes')
remotes::install_github('coolbutuseless/tickle')
```

## Hello World

Things to note:

-   Define a reactive variable for the slider before defining the UI
-   UI specificaiton created with nested `tic_*()` calls.
-   Some commands (e.g. `tic_button()`) have an explicit command
    function which is run when they are activated.
-   After defining the UI specificaiton, it is rendered to screen with
    `render_ui()`

``` r
library(tickle)

happiness <- reactive_dbl(40)

ui_spec <- tic_window(
 title = "Hello World", 
 tic_row(
 tic_col(
 tic_button("Hello", command = function() {message("Hello")}, style = 'primary'),
 tic_button("World", command = function() {message("World")})
 ),
 tic_col(
 tic_slider(happiness),
 tic_label(textvariable = happiness)
 )
 )
)

win <- render_ui(ui_spec)
```

## Gallery

| | |
|-------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
| <a href="https://coolbutuseless.github.io/package/tickle/articles/detailed-example.html"> <img src="man/figures/demo-complex.png" width="80%" /> </a> | <a href="https://coolbutuseless.github.io/package/tickle/articles/juliaset.html"> <img src="man/figures/julia.png" width="80%" /> </a> |
| <a href="https://coolbutuseless.github.io/package/tickle/articles/ggreview.html"><img src="man/figures/ggreview-snap.png" width="80%" /> </a> | <a href="https://coolbutuseless.github.io/package/tickle/articles/idle.html"><img src="man/figures/idle.png" width="80%" /> </a> |

## Examples/Vignettes

Please view the online vignettes for more details on how to use
`{tickle}`

-   [Introductory
    Examples](https://coolbutuseless.github.io/package/tickle/articles/helloworld.html)
-   [Big example with lots of
    widgets](https://coolbutuseless.github.io/package/tickle/articles/detailed-example.html)
-   [Reactive
    Values](https://coolbutuseless.github.io/package/tickle/articles/reactive.html)
-   [Annotate ggplots (using mouse
    events)](https://coolbutuseless.github.io/package/tickle/articles/ggreview.html)
-   [Pop-up
    Windows](https://coolbutuseless.github.io/package/tickle/articles/popups.html)
-   [Overview of all Widgets &
    Containers](https://coolbutuseless.github.io/package/tickle/articles/widgets.html)
-   [JuliaSet explorer (using keyboard events and rendering to a grid
    window)](https://coolbutuseless.github.io/package/tickle/articles/juliaset.html)
-   [Changing
    font](https://coolbutuseless.github.io/package/tickle/articles/fonts.html)
-   [Understanding widget
    layout](https://coolbutuseless.github.io/package/tickle/articles/packing.html)
-   [Continuous rain drops using an idle
    callback](https://coolbutuseless.github.io/package/tickle/articles/idle.html)
-   [Including images in
    buttons](https://coolbutuseless.github.io/package/tickle/articles/image.html)

## Containers

Containers are ways of grouping multiple widgets.

Containers can be nested within other containers to achieve complex
layouts.

| Container | Code/Description |
|-------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|
| <img src="man/figures/widgets/container-window.png" width="200" /> | <code>tic_window(…)</code> Create a top level window |
| <img src="man/figures/widgets/container-col.png" width="100" /> | <code>tic_col(A, B, C)</code> Layout objects in column |
| <img src="man/figures/widgets/container-row.png" width="200" /> | <code>tic_row(A, B, C)</code> Layout objects rowwise |
| <img src="man/figures/widgets/container-frame.png" width="200" /> | <code>tic_frame(…)</code> Invisible container. Useful for advanced users who want to customize layout |
| <img src="man/figures/widgets/container-labelframe.png" width="200" /> | <code>tic_labelframe(…)</code> Frame with a a label and usually visible outline |
| <img src="man/figures/widgets/container-notebook.png" width="200" /> | <code>tic_notebook(A, B, C)</code> Tabbed display |
| <img src="man/figures/widgets/container-panedwindow.png" width="200" /> | <code>tic_panedwindow(A, B, C)</code> Layout multiple elements which can be resized as panes |

## Widgets

| Widget | Code/Description |
|------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
| <img src="man/figures/widgets/widget-label.png" width="200" /> | <code>tic_label(…)</code> Display text. If you need headings rather than body text, Use `style = 'h1'` to `style = 'h5'` for different sized text |
| <img src="man/figures/widgets/widget-button.png" width="200" /> | <code>tic_button(…)</code> Clickable button. Available `style` options: ‘primary’, ‘seconary’, ‘info’, ‘success’, ‘warning’, ‘danger’, ‘light’, ‘dark’ |
| <img src="man/figures/widgets/widget-checkbutton-default.png" width="200" /> | <code>tic_checkbutton(…)</code> On/off button (default styling) |
| <img src="man/figures/widgets/widget-checkbutton-toggle.png" width="200" /> | <code>tic_checkbutton(…)</code> On/off button with `style = 'toggle'` |
| <img src="man/figures/widgets/widget-checkbutton-switch.png" width="200" /> | <code>tic_checkbutton(…)</code> On/off button with `style = 'switch'` |
| <img src="man/figures/widgets/widget-radiobutton.png" width="200" /> | <code>tic_radiobutton(…)</code> Groups of mutually exclusion options |
| <img src="man/figures/widgets/widget-menubutton.png" width="200" /> | <code>tic_menubutton(…)</code> Button which displays a drop-down menu |
| <img src="man/figures/widgets/widget-canvas.png" width="200" /> | <code>tic_canvas(…)</code> General drawing canvas |
| <img src="man/figures/widgets/widget-spinbox.png" width="200" /> | <code>tic_spinbox(…)</code> Choose options |
| <img src="man/figures/widgets/widget-combobox.png" width="200" /> | <code>tic_combobox(…)</code> Choose options |
| <img src="man/figures/widgets/widget-textentry.png" width="200" /> | <code>tic_textentry(…)</code> Single line text entry |
| <img src="man/figures/widgets/widget-textbox.png" width="200" /> | <code>tic_textbox(…)</code> Multipe line text entry |
| <img src="man/figures/widgets/widget-progressbar.png" width="200" /> | <code>tic_progressbar(…)</code> Progress bar |
| <img src="man/figures/widgets/widget-slider.png" width="200" /> | <code>tic_slider(…)</code> Slider |

## Popups

*Popups* are windows which are initiated separate from the main UI.

| Popup | Code/Description |
|----------------------------------------------------------------------|-----------------------------------------|
| <img src="man/figures/widgets/popup-color-picker.png" width="200" /> | <code>popup_color_picker()</code> |
| <img src="man/figures/widgets/popup-messagebox.png" width="200" /> | <code>popup_messagebox()</code> |
| <img src="man/figures/widgets/popup-open-file.png" width="200" /> | <code>popup_open_file()</code> |
| <img src="man/figures/widgets/popup-save-file.png" width="200" /> | <code>popup_save_file()</code> |

## Canvas

After creating a canvas with `tic_canvas()`, it can be manipulated with
the following commands:

-   Draw on the canvas
    -   `canvas_line()`
    -   `canvas_text()`
    -   `canvas_rect()`
    -   `canvas_polygon()`
    -   `canvas_oval()`
    -   `canvas_arc()`
-   `canvas_plot()` render a plot to the canvas
-   `canvas_clear()` clear all objects from the canvas
-   `canvas_image()` render an image from a file to the canvas
-   `canvas_save()` save the contents of the canvas to an image file.

The actual canvas in tcl/tk renders *structured graphics* and it is much
more like SVG or PDF than just a simple array of pixels.

The canvas implementation in this package treats the canvas as just a
raster object i.e. a rectangular collection of pixels. This made it
easier to write this package and keep the API/syntax simple, but it
doesn’t unleash the full power of the canvas.

The effort to write a more complete abstraction over the canvas is not
currently warranted. **Please get in contact if such a facility is
important to you.**

# Theme

The theme for this package is an adaptaton of the `sun-valley-light`
theme available [from rdbende on
github](https://github.com/rdbende/Sun-Valley-ttk-theme).

The `sun-valley-light` theme is MIT licensed (see “LICENSE-sun-valley”)
and has been adapted into the theme `r-sun-valley-light` included in
this package which has the following extra features:

-   Styles ‘h1’ through ‘h5’ for different sized heading text to use
    with `tic_label()` widgets.
    -   To use: `tic_label(..., style = 'h1')`
-   Standard buttons colours from
    [Bootstrap](https://getbootstrap.com/docs/4.0/components/buttons/)
    to use with `tic_button()` widgets.
    -   To use: `tic_button(..., style = 'primary')`
    -   Available styles: primary, secondary, success, danger, warning,
        info, light, dark

## Possible Future Features

The following items are not yet implemented, or incomplete:

-   Popup menus when a user right-clicks in the window.
-   No access yet to the “grid” geometry layout.
-   treeview, listbox and some other widgets

## Package Name

-   `tcl` is the scripting language
-   `tk` is the graphics toolkit for `tcl`
-   `tcl/tk` is often how the langauge and toolkit are talked about as a
    single entity
-   `{tcltk}` is the R package interfacing to `tcl/tk`
-   `tcl` is often pronounced as “tickle” i.e. `tcl/tk` =
    “tickle-tee-kay”

## Acknowledgements

-   R Core for developing and maintaining the language.
-   CRAN maintainers, for patiently shepherding packages onto CRAN and
    maintaining the repository

tickle

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README