Package 'RKernel'

Title: Yet Another R Kernel for Jupyter
Description: Provides a kernel for Jupyter.
Authors: Martin Elff [aut, cre] (ORCID: <https://orcid.org/0000-0001-9032-9739>)
Maintainer: Martin Elff <[email protected]>
License: GPL-2
Version: 1.3
Built: 2026-05-29 19:40:31 UTC
Source: https://github.com/melff/RKernel

Help Index

Add a Class to the 'Displayed' Ones

Description

Add a class to those who are output using display() when they are autoprinted, i.e. returned as the value of the last expression in a Jupyter notebook cell.

Usage

add_displayed_classes(x)

Arguments

x

A character string, the name of a class.

Add a handler for HTTP requests with slug given by 'slug'.

Description

Add a handler for HTTP requests with slug given by 'slug'.

Usage

add_http_handler(slug, handler)

Arguments

slug

The first part (slug) of the URL to be handled
handler

A function that handles GET requests with URLs that have 'slug' as path component

Add a Class to the 'Paged' Ones

Description

Add a class to those who are output using Page() when they are autoprinted, i.e. returned as the value of the last expression in a Jupyter notebook cell.

Usage

add_paged_classes(x)

Arguments

x

A character string, the name of a class.

A constructor function for a class that inherits from 'AnyWidget' (or 'AnyWidgetClass')

Description

A constructor function for a class that inherits from 'AnyWidget' (or 'AnyWidgetClass')

Usage

AnyWidget(esm, css, anywidget_id, ...)

Arguments

esm

Character string, code for an ECMAscript (Javascript) moldue
css

Character string with CSS code
anywidget_id

Character string with a unique ID for the widget
...

Other arguments which create additional components of the widget

Examples

## Not run:  
  esm <- '
  function render({ model, el }) {
        let button = document.createElement("button");
        button.innerHTML = `count is ${model.get("value")}`;
        button.addEventListener("click", () => {
          model.set("value", model.get("value") + 1);
          model.save_changes();
        });
        model.on("change:value", () => {
          button.innerHTML = `count is ${model.get("value")}`;
        });
        el.classList.add("counter-widget");
        el.appendChild(button);
      }
      export default { render };
  '
  css <- '
      .counter-widget button { 
                              color: white; 
                              font-size: 1.75rem; 
                              background-color: #ea580c; 
                              padding: 0.5rem 1rem; 
                              border: none; 
                              border-radius: 0.25rem; 
      }
      .counter-widget button:hover { background-color: #9a3412; }
  '
  CountWidget <- AnyWidget(
              esm = esm,
              css = css,
              anywidget_id = "CountWidget",
              value = Integer(0)
             )
  CountWidget(value=42)

## End(Not run)

Support for AnyWidgets

Description

Support for AnyWidgets

Support for AnyWidgets

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> AnyWidget

Public fields

_model_module

Name of the Javascript module with the model

_model_module_version

Version of the module where the model is defined

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript model view in the frontend

_view_module

Name of the module where the view is defined

_view_module_version

Version of the module where the view is defined

_anywidget_id

A Unicode trait

_css

A Unicode trait with optional CSS code

_esm

A Unicode trait with optional Javascript code

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
AnyWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Boolean Traitlets

Description

A class and a constructor function to create boolean trait(let)s.

Usage

Boolean(...)

Arguments

...

Arguments that are passed to the initialize method of 'BooleanClass'

Super class

RKernel::Trait -> Boolean

Public fields

value

A logical vector, usually of length 1

optional

Logical, whether an initializing logical value must be provided

coerce

Logical, whether 'as.logical()' is implicitely used when a value is assigned to the trait

length

Integer, the length of the logical vector that poses as the value of the traitlet.

Methods

Public methods

Inherited methods

Method validator()

A validator method

Usage
BooleanClass$validator(value)
Arguments
value

A value to be checked for validity

Method new()

The initializing method

Usage
BooleanClass$new(
  initial,
  coerce = TRUE,
  optional = length(initial) == 0,
  length = 1
)
Arguments
initial

A value with which the traitlet is initialized

coerce

Logical, used to initialize the 'coerce' field

optional

Logical, used to initialize the 'optional' field

length

Integer, used to initialize the 'length' field

Method clone()

The objects of this class are cloneable with this method.

Usage
BooleanClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Widgets for Floating Point Number Ranges

Description

An R6 class and a constructor function for the creation of widgets that can be used to manipulate floating pairs of point numbers that are bounded within an interval, where a pair defines a number range.

Usage

BoundedFloatRangeWidget(value, min, max, ...)

Arguments

value

A pair of floating point values.
min

The lower bound of the enclosing interval.
max

The upper bound of the enclosing interval.
...

Other arguments, passed to the superclass initializer.

Details

The function BoundedFloatRangeWidget creates objects of the R6 Class "BoundedFloatRangeWidgetClass", which in turn have the S3 class attribute "BoundedFloatRangeWidget"

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> BoundedFloatRangeWidget

Public fields

value

A Float traitlet.

min

A Float traitlet, the minimum allowed value.

max

A Float traitlet, the maximum allowed value.

Methods

Public methods

Inherited methods

Method validate_value()

Validate the "value" after assignment.

Usage
BoundedFloatRangeWidgetClass$validate_value(value)
Arguments
value

A value, should be numeric.

Method validate_min()

Validate the "min" field after assignment.

Usage
BoundedFloatRangeWidgetClass$validate_min(min)
Arguments
min

A minimum value, should be numeric.

Method validate_max()

Validate the "max" field after assignment.

Usage
BoundedFloatRangeWidgetClass$validate_max(max)
Arguments
max

A maximum value, should be numeric.

Method new()

Usage
BoundedFloatRangeWidgetClass$new(...)
Arguments
...

Arguments passed to the superclass initializer.

Method clone()

The objects of this class are cloneable with this method.

Usage
BoundedFloatRangeWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Widgets for Text Elements with Floating Point Numbers Bounded within an Interval

Description

An R6 class and a constructor function for the creation of widgets that can be used to manipulate floating point numbers.

Usage

BoundedFloatText(value = 0, min = 0, max = 100, step = 0.1, ...)

Arguments

value

Initial value of the floating point number.
min

Lower limit of the enclosing interval.
max

Upper limit of the enclosing interval.
step

Increment by which the number is increased or decreased by the text field controls.
...

Other arguments.

Details

The function BoundedFloatText creates objects of the R6 Class "BoundedFloatTextClass", which in turn have the S3 class attribute "BoundedFloatText".

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::BoundedFloatWidget -> BoundedFloatText

Public fields

_model_name

Name of the Javascript model in the frontend.

_view_name

Name of the Javascript view in the frontend.

disabled

A Boolean traitlet, whether the text widget is disabled.

continuous_update

A Boolean traitlet, whether the text widget is continuously updated upon change in the frontend.

step

A Float traitlet, a step size by which the value is incremented or decremented if the arrows are clicked.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
BoundedFloatTextClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Widgets for Bounded Floating Point Numbers

Description

An R6 class and a constructor function for the creation of widgets that can be used to manipulate floating point numbers that are bounded within an interval

Usage

BoundedFloatWidget(value, min, max, ...)

Arguments

value

The floating point value
min

The lower bound of the interval
max

The upper bound of the interval
...

Other arguments, passed to the superclass initializer

Details

The function BoundedFloatWidget creates objects of the R6 Class "BoundedFloatWidgetClass", which in turn have the S3 class attribute "BoundedFloatWidget"

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> BoundedFloatWidget

Public fields

value

A Float traitlet.

min

A Float traitlet, the minimum allowed value.

max

A Float traitlet, the maximum allowed value.

Methods

Public methods

Inherited methods

Method validate_value()

Validate the "value" after assignment.

Usage
BoundedFloatWidgetClass$validate_value(value)
Arguments
value

A value, should be numeric.

Method validate_min()

Validate the "min" field after assignment.

Usage
BoundedFloatWidgetClass$validate_min(min)
Arguments
min

A minimum value, should be numeric.

Method validate_max()

Validate the "max" field after assignment.

Usage
BoundedFloatWidgetClass$validate_max(max)
Arguments
max

A maximum value, should be numeric.

Method new()

Initialize an object.

Usage
BoundedFloatWidgetClass$new(value, min, max, ...)
Arguments
value

The floating point value.

min

The lower bound of the interval.

max

The upper bound of the interval.

...

Other arguments, passed to the superclass initializer.

Method clone()

The objects of this class are cloneable with this method.

Usage
BoundedFloatWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Widgets for Text Elements with Integer Numbers Bounded within an Interval

Description

An R6 class and a constructor function for the creation of widgets that can be used to manipulate integer numbers

Usage

BoundedIntText(value = 0, min = 0, max = 100, step = 1, ...)

Arguments

value

Initial value of the integer number
min

Lower limit of the enclosing interval
max

Upper limit of the enclosing interval
step

Increment by which the number is increased or decreased by the text field controls
...

Arguments passed to the superclass constructor

Details

The function BoundedIntText creates objects of the R6 Class "BoundedIntTextClass", which in turn have the S3 class attribute "BoundedIntText"

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::BoundedIntWidget -> BoundedIntText

Public fields

_model_name

Name of the Javascript model in the frontend.

_view_name

Name of the Javascript view in the frontend.

disabled

A Boolean traitlet, whether the text widget is disabled.

continuous_update

A Boolean traitlet, whether the text widget is continuously updated upon change in the frontend.

step

A Integer traitlet, a step size by which the value is incremented or decremented if the arrows are clicked.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
BoundedIntTextClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Widgets for Bounded Integer Numbers

Description

An R6 class and a constructor function for the creation of widgets that can be used to manipulate integer numbers that are bounded within an interval.

Usage

BoundedIntWidget(value, min, max, ...)

BoundedIntRangeWidget(value, min, max, ...)

Arguments

value

A pair of integer values
min

The lower bound of the enclosing interval
max

The upper bound of the enclosing interval
...

Other arguments, passed to the superclass initializer

Details

The function BoundedIntWidget creates objects of the R6 Class "BoundedIntWidgetClass", which in turn have the S3 class attribute "BoundedIntWidget".

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> BoundedIntWidget

Public fields

value

A Integer traitlet.

min

A Integer traitlet, the minimum allowed value.

max

A Integer traitlet, the maximum allowed value.

Methods

Public methods

Inherited methods

Method validate_value()

Validate the "value" after assignment.

Usage
BoundedIntWidgetClass$validate_value(value)
Arguments
value

A value, should be an integer number.

Method validate_min()

Validate the "min" field after assignment.

Usage
BoundedIntWidgetClass$validate_min(min)
Arguments
min

A minimum value, should be an integer number.

Method validate_max()

Validate the "max" field after assignment.

Usage
BoundedIntWidgetClass$validate_max(max)
Arguments
max

A maximum value, should be an integer number.

Method new()

Usage
BoundedIntWidgetClass$new(...)
Arguments
...

Arguments passed to the superclass initializer

Method clone()

The objects of this class are cloneable with this method.

Usage
BoundedIntWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> BoundedIntRangeWidget

Public fields

value

A Integer traitlet.

min

A Integer traitlet, the minimum allowed value.

max

A Integer traitlet, the maximum allowed value.

Methods

Public methods

Inherited methods

Method validate_value()

Validate the "value" after assignment.

Usage
BoundedIntRangeWidgetClass$validate_value(value)
Arguments
value

A value, should be an integer number.

Method validate_min()

Validate the "min" field after assignment.

Usage
BoundedIntRangeWidgetClass$validate_min(min)
Arguments
min

A minimum value, should be an integer number.

Method validate_max()

Validate the "max" field after assignment.

Usage
BoundedIntRangeWidgetClass$validate_max(max)
Arguments
max

A maximum value, should be an integer number.

Method new()

Usage
BoundedIntRangeWidgetClass$new(...)
Arguments
...

Arguments passed to the superclass initializer.

Method clone()

The objects of this class are cloneable with this method.

Usage
BoundedIntRangeWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Widgets for Bounded Floating Point Numbers on a logarithmic scale

Description

An R6 class and a constructor function for the creation of widgets that can be used to manipulate floating point numbers that are bounded within an interval on an logarithmic scale

Usage

BoundedLogFloatWidget(value, min, max, base, ...)

Arguments

value

The floating point value.
min

The lower bound of the interval.
max

The upper bound of the interval.
base

The base of the logarithm.
...

Other arguments, passed to the superclass initializer.

Details

The function BoundedLogFloatWidget creates objects of the R6 Class "BoundedLogFloatWidgetClass", which in turn have the S3 class attribute "BoundedLogFloatWidget"

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> BoundedLogFloatWidget

Public fields

value

A Float traitlet.

min

A Float traitlet, the minimum allowed value.

max

A Float traitlet, the maximum allowed value.

base

A Float traitlet, the logarithmic base.

Methods

Public methods

Inherited methods

Method validate_value()

Validate the "value" after assignment.

Usage
BoundedLogFloatWidgetClass$validate_value(value)
Arguments
value

A value, should be numeric.

Method validate_min()

Validate the "min" field after assignment.

Usage
BoundedLogFloatWidgetClass$validate_min(min)
Arguments
min

A minimum value, should be numeric.

Method validate_max()

Validate the "max" field after assignment.

Usage
BoundedLogFloatWidgetClass$validate_max(max)
Arguments
max

A maximum value, should be numeric.

Method new()

Initialize an object.

Usage
BoundedLogFloatWidgetClass$new(value, min, max, ...)
Arguments
value

The floating point value.

min

The lower bound of the interval.

max

The upper bound of the interval.

...

Other arguments, passed to the superclass initializer.

Method clone()

The objects of this class are cloneable with this method.

Usage
BoundedLogFloatWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Box Containers

Description

Classes and constructor functions to create box container widgets

Usage

Box(..., layout = NULL)

HBox(..., layout = NULL, wrap = FALSE)

VBox(..., layout = NULL, wrap = FALSE)

GridBox(..., layout = NULL)

Arguments

...

Arguments passed to the superclass constructor
layout

An optional layout widget
wrap

Logical value, whether lines of widgets should be wrapped?

Details

VBox creates vertical boxes, HBox creates horizontal boxes, GridBox creates a grid box. In a vertical box widgets are arranged one below the other, in a horizontal box widgets are arranged side-by-side, in a grid box widget are arraned in a grid.

Functions

  • Box(): A baseline box constructor

  • HBox(): A horizontal box constructor

  • VBox(): A vertical box constructor

  • GridBox(): A grid box constructor

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> Box

Public fields

_model_module

Name of the Javascript module with the model

_model_module_version

Version of the module where the model is defined

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript model view in the frontend

_view_module

Name of the module where the view is defined

_view_module_version

Version of the module where the view is defined

children

A generic vector with the widgets in the container

box_style

The string that describes the button style

Methods

Public methods

Inherited methods

Method new()

An initializer function

Usage
BoxClass$new(children = list(), ...)
Arguments
children

A list of widgets

...

Other arguments, passed to the superclass method

Method notify_children_displayed()

Notifies children that they are displayed

Usage
BoxClass$notify_children_displayed()

Method clone()

The objects of this class are cloneable with this method.

Usage
BoxClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::Box -> HBox

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript model view in the frontend

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
HBoxClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::Box -> VBox

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript model view in the frontend

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
VBoxClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::Box -> GridBox

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript model view in the frontend

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
GridBoxClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Buttons

Description

Classes and constructor functions for boxes and box styles

Usage

Button(...)

ButtonStyle(...)

Arguments

...

Arguments passed to the inializer

Functions

  • Button(): A button constructor

  • ButtonStyle(): A constructor for a button style

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> Button

Public fields

_model_module

Name of the Javascript module with the model

_model_module_version

Version of the module where the model is defined

_model_name

Name of the Javascript model in the frontend

_view_module

Name of the module where the view is defined

_view_module_version

Version of the module where the view is defined

_view_name

Name of the Javascript model view in the frontend

description

A button description

disabled

Boolean, whether the button is disabled

icon

Name of an optional icon

button_style

The string that describes the button style

tooltip

An optional tooltip string

style

The button style, an object of class "ButtonStyleClass"

Methods

Public methods

Inherited methods

Method on_click()

Add or remove a click handler

Usage
ButtonClass$on_click(handler, remove = FALSE)
Arguments
handler

A function that is called when the button is clicked

remove

Logical value, whether the handler is to be removed

Method click()

Function that calls the click event handlers

Usage
ButtonClass$click()

Method clone()

The objects of this class are cloneable with this method.

Usage
ButtonClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DescriptionStyle -> ButtonStyle

Public fields

_model_name

Name of the Javascript model in the frontend

button_color

The colour of the button

font_family

The font family of the button label

font_size

The font size of the button label

font_style

The font style of the button label

font_variant

The font variant of the button label

font_weight

The font weight of the button label

text_color

The text colour of the button label

text_decoration

The text decoration of the button label

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
ButtonStyleClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Raw Bytes Traitlets

Description

A class and a constructor function to create (raw) bytes trait(let)s.

Usage

Bytes(...)

Arguments

...

Arguments that are passed to the initialize method of 'BytesClass'

Super class

RKernel::Trait -> Bytes

Public fields

value

A raw bytes vector

optional

Logical, whether an initializing logical value must be provided

coerce

Logical, whether 'as.raw()' is implicitely used when a value is assigned to the trait

Methods

Public methods

Inherited methods

Method validator()

A validator method

Usage
BytesClass$validator(value)
Arguments
value

A value to be checked for validity

Method new()

The initializing method

Usage
BytesClass$new(initial = raw(0), coerce = TRUE, optional = TRUE)
Arguments
initial

A value with which the traitlet is initialized

coerce

Logical, used to initialize the 'coerce' field

optional

Logical, used to initialize the 'optional' field

Method clone()

The objects of this class are cloneable with this method.

Usage
BytesClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

A Dispatcher for Callbacks

Description

Objects in this class are collections of callbacks functions usually related to certain events. The function CallbackDispachter can be used as an constructor

Usage

CallbackDispatcher(...)

Arguments

...

Arguments passed to the inializer

Functions

  • CallbackDispatcher(): The constructor function, returns an Object of Class "CallbackDispatcherClass"

Methods

Public methods

Method register()

Register a function as a callback

Usage
CallbackDispatcherClass$register(handler, remove)
Arguments
handler

A function

remove

A logical value; whether the function is added or removed from the list of callbacks

Method clear()

Remove all callback functions

Usage
CallbackDispatcherClass$clear()

Method suspend_handlers()

Suspend registered callback functions

Usage
CallbackDispatcherClass$suspend_handlers()

Method activate_handlers()

(Re-)activate registered callback functions

Usage
CallbackDispatcherClass$activate_handlers()

Method run()

Run all registered callback functions

Usage
CallbackDispatcherClass$run(...)
Arguments
...

Aruments passed on to the handler functions

Method clone()

The objects of this class are cloneable with this method.

Usage
CallbackDispatcherClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Checkbox Widgets

Description

A class and a constructor function to create checkbox widgets

Usage

CheckboxStyle(...)

Checkbox(...)

Arguments

...

Arguments passed to the inializer

Functions

  • CheckboxStyle(): The constructor for checkbox widgets

  • Checkbox(): The constructor for checkbox styles

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DescriptionStyle -> CheckboxStyle

Public fields

_model_name

Name of the Javascript model in the frontend

background

The background color

required_version

Minimum required ipywidgets version in which the current widget class is supported.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
CheckboxStyleClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> Checkbox

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript model view in the frontend

description

A button description

disabled

Boolean, whether the button is disabled

indent

Boolean, whether to indent the checkbox

value

Boolean, whether the box is checked

style

The checkbox style, an object of class "CheckboxStyleClass"

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
CheckboxClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Color picker widgets

Description

A class and constructor function to create color picker widgets

Usage

ColorPicker(...)

Arguments

...

Arguments passed to the inializer

Functions

  • ColorPicker(): The constructor for color-picker widgets

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> ColorPicker

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript model view in the frontend

concise

Boolean, whether the a short version should be shown

disabled

Boolean, whether the button is disabled

value

Unicode string, the color value

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
ColorPickerClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

A Color String Trait

Description

A Color String Trait

A Color String Trait

Usage

Color(...)

Arguments

...

Arguments passed to the trait instance initializer

Super classes

RKernel::Trait -> RKernel::Unicode -> Color

Public fields

optional

Logical value, whether a length-zero value is allowed.

Methods

Public methods

Inherited methods

Method validator()

Check the value assigned to the traitlet.

Usage
ColorTraitClass$validator(value)
Arguments
value

The value assigned to the traitlet.

Method clone()

The objects of this class are cloneable with this method.

Usage
ColorTraitClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Comms - connections between the kernel and the frontend

Description

This R6 Class provides for bidirectional communication between the R Kernel and the Jupyter frontend, e.g. a Jupyter notebook

Usage

Comm(...)

Arguments

...

Arguments passed to the inializer

Details

Objects of this class are used to communicate to the frontend via custom messages.

Functions

  • Comm(): A constructor function for objects of class "CommClass"

Public fields

id

A character string, the comm id

target_name

A character string, the target

handlers

A list of handler functions

data

A list of data

Methods

Public methods

Method new()

Initialize a 'Comm' object

Usage
CommClass$new(target_name, id = uuid(), handlers = list())
Arguments
target_name

A string, the name of the target

id

A string, the comm id

handlers

A list of handler functions

kernel

The relevant kernel

Method open()

Open a comm

Usage
CommClass$open(data, metadata = emptyNamedList, buffers = NULL)
Arguments
data

A named list

metadata

A named list

buffers

A list of raw vectors or NULL

Method send()

Send data through a comm

Usage
CommClass$send(data, metadata = emptyNamedList, buffers = NULL)
Arguments
data

A named list

metadata

A named list

buffers

A list of raw vectors or NULL

Method close()

Close a comm

Usage
CommClass$close(
  data = emptyNamedList,
  metadata = emptyNamedList,
  buffers = NULL
)
Arguments
data

A named list

metadata

A named list

buffers

A list of raw vectors or NULL

Method clone()

The objects of this class are cloneable with this method.

Usage
CommClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

A Manager for Comms

Description

Objects of this class are used internally to manage comms, they are not meant to be used by end-users.

Usage

CommManager(...)

Arguments

...

Arguments passed to the inializer

Details

See the documentation of Jupyter custom messages.

Functions

  • CommManager(): A constructor for objects in the 'CommManagerClass'

Public fields

comms

A list of Comms.

Methods

Public methods

Method add_handlers()

Add a handler for a comm target

Usage
CommManagerClass$add_handlers(target_name, handlers)
Arguments
target_name

A string, the name of the target.

handlers

A named list of handlers

Method remove_handlers()

Remove the handlers of a comm target

Usage
CommManagerClass$remove_handlers(target_name)
Arguments
target_name

A string, the name of the target

Method has_handlers()

Check if handlers for a target exist

Usage
CommManagerClass$has_handlers(target_name)
Arguments
target_name

A string, the name of the target

Method get_handlers()

Get the handlers for a target

Usage
CommManagerClass$get_handlers(target_name)
Arguments
target_name

A string, the name of the target

Method get_comms()

Get all comms or all comms related to a target

Usage
CommManagerClass$get_comms(target_name = NULL)
Arguments
target_name

A string, the name of the target or NULL. If NULL,

Method new_comm()

Create a new comm related to a target

Usage
CommManagerClass$new_comm(target_name)
Arguments
target_name

A string, the name of the target

Method handle_open()

Handle a 'comm open' request from the frontend

Usage
CommManagerClass$handle_open(target_name, id, data)
Arguments
target_name

A string, the name of the target

id

A string, the comm id

data

Data sent by the frontend

Method handle_close()

Handle a 'comm close' request from the frontend

Usage
CommManagerClass$handle_close(id, data)
Arguments
id

A string, the comm id

data

Data sent by the frontend

Method handle_msg()

Handle a comm message from the frontend

Usage
CommManagerClass$handle_msg(id, data)
Arguments
id

A string, the comm id

data

Data sent by the frontend

Method has()

Check whether the comm manager has info about comm with an id

Usage
CommManagerClass$has(id)
Arguments
id

A string, possibly a comm id

Method send()

Send data to the frontend

Usage
CommManagerClass$send(id, data, metadata = emptyNamedList, buffers = NULL)
Arguments
id

A string, the comm id

data

A named list

metadata

A named list

buffers

A list of raw vectors or NULL

Method send_open()

Send an 'open' request to the frontend

Usage
CommManagerClass$send_open(
  id,
  target_name,
  data,
  metadata = emptyNamedList,
  buffers = NULL
)
Arguments
id

A string, the comm id

target_name

A string, the name of the target

data

A named list

metadata

A named list

buffers

A list of raw vectors or NULL

Method send_close()

Send an 'close' request to the frontend

Usage
CommManagerClass$send_close(
  id,
  data = emptyNamedList,
  metadata = emptyNamedList,
  buffers = NULL
)
Arguments
id

A string, the comm id

data

A named list

metadata

A named list

buffers

A list of raw vectors or NULL

Method list_targets()

Return a list of targets

Usage
CommManagerClass$list_targets()

Method clone()

The objects of this class are cloneable with this method.

Usage
CommManagerClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Yet Another Widget Class

Description

This is a base class for widgets that use the 'controls' module.

Super classes

RKernel::HasTraits -> RKernel::Widget -> CoreWidget

Public fields

_model_module

Name of the Javascript module with the model

_model_module_version

Version of the module where the model is defined

_model_name

Name of the Javascript model in the frontend

_view_module

Version of the module where the view is defined

_view_module_version

Version of the module where the view is defined

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
CoreWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Send CSS code to the frontend

Description

Send CSS code in a character string or a text file to the frontend.

Usage

CSS(text, file)

Arguments

text

A character string with CSS styling information
file

Path of a file with CSS styling information

HTML Tables with Interactive Controls

Description

Objects of class "dataTable" provide HTML tables with interactive controls powered by the DataTable Javascript library.

Usage

dataTable(x, ...)

## Default S3 method:
dataTable(x, ...)

## S3 method for class 'data.frame'
dataTable(x, ...)

## S3 method for class 'data.set'
dataTable(x, ...)

## S3 method for class 'importer'
dataTable(x, ...)

## S3 method for class 'dataTable'
display_data(
  x,
  ...,
  metadata = emptyNamedList,
  id = attr(x, "id"),
  update = FALSE
)

Arguments

x

A "dataTable" object
...

Other arguments passed to the initialization method of 'dataTableClass' R6 objects
metadata

A list of metadata strings
id

An ID string
update

A logical value; whether an existing display item will be updated

Methods (by class)

  • dataTable(default): Default method

  • dataTable(data.frame): data.frame method

  • dataTable(data.set): data.set method

  • dataTable(importer): importer method

Methods (by generic)

  • display_data(dataTable): dataTable method for display_data

Functions

  • dataTable(): A dataTable constructor

Public fields

w

A container widget or NULL

page

Number of the current page

m

Width of the object divided by 'size'

r

Remainder of the widht of the object divided by 'size'

size

Number of columns in each group for horizontal paging

iframe

An <iframe> container or NULL

b_left

Button to scroll left

b_right

Button to scroll right

b_first

Button to scroll to the first group of columns

b_last

Button to scroll to the last group of columns

dt

HTML code for the visible table

obj

The tabular object being dispayed

label

A string label that shows the columns being displayed

style

A string with CSS styling

navigator

A container widget that contains the navigator buttons

Methods

Public methods

Method new()

Initialize the DataTable

Usage
dataTableClass$new(obj, size = 50, ...)
Arguments
obj

The object to be displayed

size

An integer, the number of columns pre-formatted on each page.

...

Other arguments, ignored

Method show_columns()

Show which columns are displayed

Usage
dataTableClass$show_columns()

Method page_left()

Go one page to the left

Usage
dataTableClass$page_left()

Method page_right()

Go one page to the right

Usage
dataTableClass$page_right()

Method page_first()

Go to the first page (to the left)

Usage
dataTableClass$page_first()

Method page_last()

Go to the last page (to the right)

Usage
dataTableClass$page_last()

Method draw()

Draw the iframe with the data table contents

Usage
dataTableClass$draw()

Method clone()

The objects of this class are cloneable with this method.

Usage
dataTableClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Date Traitlets

Description

A class and constructor of date traitlets.

Usage

Date(...)

## S3 method for class 'DateClass'
as.Date(x, ...)

Arguments

...

Other arguments.
x

A date traitlet.

Super class

RKernel::Trait -> DateClass

Public fields

value

A date.

coerce

Logical value, whether assignments to the value field should be coerced to the appropriate type.

Methods

Public methods

Inherited methods

Method validator()

Check the value assigned to the traitlet.

Usage
DateClass$validator(value)
Arguments
value

The value assigned to the traitlet.

Method new()

Initialize the traitlet.

Usage
DateClass$new(
  initial = as.Date(integer(0)),
  year = integer(0),
  month = integer(0),
  day = integer(0),
  coerce = TRUE
)
Arguments
initial

An optional Date object or date string

year

An optional integer

month

An optional integer

day

An optional integer

coerce

An optional logical value

Method clone()

The objects of this class are cloneable with this method.

Usage
DateClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Date Picker Widgets

Description

An R6 class and constructor function for date picker widgets

Usage

DatePicker(...)

Arguments

...

Arguments passed to the inializer

Functions

  • DatePicker(): A constructor for dat picker widgets

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> DatePicker

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

value

The date

disabled

Boolean, whether the user can make changes

min

Minimum selectable date

max

Maximum selectable date

step

Date step used for the picker in days

Methods

Public methods

Inherited methods

Method validate_value()

Check wether "value" is within range.

Usage
DatePickerClass$validate_value(value)
Arguments
value

A value

Method validate_min()

Validate the "min" field after assignment.

Usage
DatePickerClass$validate_min(min)
Arguments
min

A minimum value, should be an integer number.

Method validate_max()

Validate the "max" field after assignment.

Usage
DatePickerClass$validate_max(max)
Arguments
max

A maximum value, should be an integer number.

Method new()

Usage
DatePickerClass$new(...)
Arguments
...

Arguments passed to the superclass initializer

Method clone()

The objects of this class are cloneable with this method.

Usage
DatePickerClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Datetime Traitlets

Description

A class and constructor of datetime traitlets.

Usage

Datetime(...)

Time(...)

Arguments

...

Arguments that are passed to the initialize method of 'TimeClass'

Super class

RKernel::Trait -> DatetimeClass

Public fields

value

A date.

coerce

Logical value, whether assignments to the value field should be coerced to the appropriate type.

Methods

Public methods

Inherited methods

Method validator()

Check the value assigned to the traitlet.

Usage
DatetimeClass$validator(value)
Arguments
value

The value assigned to the traitlet.

Method new()

Initialize the traitlet.

Usage
DatetimeClass$new(initial = as.POSIXct(integer(0)), coerce = TRUE)
Arguments
initial

An optional POSIXct object or an object coercive into such an object

coerce

An optional logical value

Method clone()

The objects of this class are cloneable with this method.

Usage
DatetimeClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Datetime Picker Widgets

Description

An R6 class and constructor function for datetime picker widgets

Usage

DatetimePicker(...)

NaiveDatetimePicker(...)

Arguments

...

Arguments passed to the inializer

Functions

  • DatetimePicker(): A constructor for dat picker widgets

  • NaiveDatetimePicker(): A constructor for dat picker widgets

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> DatetimePicker

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

value

The date and time. If non-zero length, must have valid timezone info.

disabled

Boolean, whether the user can make changes

min

Minimum selectable date and time. If non-zero length, must have valid timezone info.

max

Maximum selectable date and time. If non-zero length, must have valid timezone info.

Methods

Public methods

Inherited methods

Method validate_tz()

Check whether time zone is valid.

Usage
DatetimePickerClass$validate_tz(value)
Arguments
value

A value

Method validate_value()

Check wether "value" is within range.

Usage
DatetimePickerClass$validate_value(value)
Arguments
value

A date and time to be checked for validity

Method validate_min()

Validate the "min" field after assignment.

Usage
DatetimePickerClass$validate_min(min)
Arguments
min

A minimum date and time to be checked for validity

Method validate_max()

Validate the "max" field after assignment.

Usage
DatetimePickerClass$validate_max(max)
Arguments
max

A maximum date and time to be checked for validity

Method new()

Usage
DatetimePickerClass$new(...)
Arguments
...

Arguments passed to the superclass initializer

Method clone()

The objects of this class are cloneable with this method.

Usage
DatetimePickerClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::DatetimePicker -> NaiveDatetimePicker

Public fields

_model_name

Name of the Javascript model in the frontend

value

The date and time. If non-zero length, must have valid timezone info.

min

Minimum selectable date and time. If non-zero length, must have valid timezone info.

max

Maximum selectable date and time. If non-zero length, must have valid timezone info.

Methods

Public methods

Inherited methods

Method validate_tz()

Check whether time zone is valid.

Usage
NaiveDatetimePickerClass$validate_tz(value)
Arguments
value

A value

Method validate_value()

Check wether "value" is within range.

Usage
NaiveDatetimePickerClass$validate_value(value)
Arguments
value

A date and time to be checked for validity

Method new()

Usage
NaiveDatetimePickerClass$new(...)
Arguments
...

Arguments passed to the superclass initializer

Method clone()

The objects of this class are cloneable with this method.

Usage
NaiveDatetimePickerClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Styling of Decscription Widgets

Description

Objects of this class contain the CSS styling of description widgets

Usage

DescriptionStyle(...)

Arguments

...

Arguments passed to the inializer

Functions

  • DescriptionStyle(): A Constructor Function for "DescriptionStyle" objects

Super classes

RKernel::HasTraits -> RKernel::Widget -> DescriptionStyle

Public fields

_model_module

Name of the Javascript module with the model

_model_module_version

Version of the module where the model is defined

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript model view in the frontend

_view_module

Version of the module where the view is defined

_view_module_version

Version of the module where the view is defined

description_width

Width of the description

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
DescriptionStyleClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Decscription Widgets

Description

Objects of this class have an optional description and a description tooltip field

Usage

DescriptionWidget(...)

Arguments

...

Arguments passed to the inializer

Functions

  • DescriptionWidget(): A Constructor Function for "DescriptionWidget" objects

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> DescriptionWidget

Public fields

_model_module

Name of the Javascript module with the model

_model_module_version

Version of the module where the model is defined

_view_module

Version of the module where the view is defined

_view_module_version

Version of the module where the view is defined

_model_name

Name of the Javascript model in the frontend

description

An optional description string

description_tooltip

An optional description tooltip

tooltip

An optional description tooltip

description_html

Boolean, whether HTML is allowed in the description

style

A "DescriptionStyle" object

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
DescriptionWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Dictionary Traitlets

Description

A class and a constructor of dictionary trait(let)s. These are lists with unique element names.

Usage

Dict(...)

Arguments

...

Arguments that are passed to the initialize method of 'DictClass'

Super classes

RKernel::Trait -> RKernel::List -> Dict

Methods

Public methods

Inherited methods

Method validator()

A function that checks the validity of an assigned value, i.e. whether the assigned value is a list with unique names

Usage
DictClass$validator(value)
Arguments
value

A value to be assigned as the traitlet value

Method clone()

The objects of this class are cloneable with this method.

Usage
DictClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

A data type analogous to Python dictionaries

Description

Objects of class "dictionary" behave similar to dictionaries. They can contain any other kind of objects, but like with Python dictionaries, only scalar indices are allowed. Unlike with Python dictionaries, numeric indices can be used well as character indices.

Usage

dictionary(...)

## S3 method for class 'dictionary'
x[i]

## S3 replacement method for class 'dictionary'
x[i] <- value

## S3 method for class 'dictionary'
print(x, force = FALSE, ...)

Arguments

...

Arbitrary objects. Should be tagged, yet currently name tags are not yet checked for.
x

A dictionary object
i

A scalar integer or character string
value

An arbitrary object
force

A logical scalar, if TRUE, each element of the dictionary is printed, if FALSE, just a brief summary is printed.

Methods (by generic)

  • [: Get an element from a dictionary

  • `[`(dictionary) <- value: Set an element in a dictionary

  • print(dictionary): Print a dictionary

Functions

  • dictionary(): A dictionary constructor

Display an R Object

Description

Sends a 'display_data' message to the frontend. Allows users to create rich display of R objects.

Usage

display(...)

Arguments

...

Arguments passed to 'display_data' methods

Prepare an R Object for Being Displayed

Description

A generic function that prepares R objects for display using display()

Usage

## S3 method for class 'Widget'
display_data(x, ..., metadata = emptyNamedList, id = uuid(), update = FALSE)

display_data(x, ...)

## Default S3 method:
display_data(
  x,
  ...,
  data,
  metadata = emptyNamedList,
  id = UUIDgenerate(),
  update = FALSE
)

## S3 method for class 'htmlwidget'
display_data(
  x,
  ...,
  metadata = emptyNamedList,
  id = UUIDgenerate(),
  update = FALSE
)

## S3 method for class 'display_data'
display_data(x, ...)

## S3 method for class 'update_display_data'
display_data(x, ...)

## S3 method for class 'svg'
display_data(x, ...)

## S3 method for class 'display_data'
update(object, ...)

## S3 method for class 'data.frame'
display_data(
  x,
  ...,
  metadata = emptyNamedList,
  id = UUIDgenerate(),
  update = FALSE
)

## S3 method for class 'data.set'
display_data(
  x,
  ...,
  metadata = emptyNamedList,
  id = UUIDgenerate(),
  update = FALSE
)

## S3 method for class 'importer'
display_data(
  x,
  ...,
  metadata = emptyNamedList,
  id = UUIDgenerate(),
  update = FALSE
)

## S3 method for class 'descriptions'
display_data(
  x,
  ...,
  metadata = emptyNamedList,
  id = UUIDgenerate(),
  update = FALSE
)

## S3 method for class 'matrix'
display_data(
  x,
  ...,
  metadata = emptyNamedList,
  id = UUIDgenerate(),
  update = FALSE
)

## S3 method for class 'html_elem'
display_data(
  x,
  ...,
  metadata = emptyNamedList,
  id = UUIDgenerate(),
  update = FALSE
)

## S3 method for class 'shiny.tag'
display_data(
  x,
  ...,
  metadata = emptyNamedList,
  id = UUIDgenerate(),
  update = FALSE
)

## S3 method for class 'shiny.tag.list'
display_data(
  x,
  ...,
  metadata = emptyNamedList,
  id = UUIDgenerate(),
  update = FALSE
)

## S3 method for class 'iframe'
display_data(
  x,
  ...,
  metadata = emptyNamedList,
  id = attr(x, "id"),
  update = FALSE
)

## S3 method for class 'htmlTable'
display_data(
  x,
  ...,
  metadata = emptyNamedList,
  id = UUIDgenerate(),
  update = FALSE
)

## S3 method for class 'tableHTML'
display_data(
  x,
  ...,
  metadata = emptyNamedList,
  id = UUIDgenerate(),
  update = FALSE
)

## S3 method for class 'help_files_with_topic'
display_data(
  x,
  ...,
  id = UUIDgenerate(),
  update = FALSE,
  embedded = FALSE,
  include_button = TRUE
)

## S3 method for class 'hsearch'
display_data(x, ..., id = UUIDgenerate(), update = FALSE)

Arguments

x

An object
...

Optional arguments tagged by mime types with mime data
metadata

A list with named elements, containing metadata
id

An identifier string
update

A logical value, whether a new display item should be created or an existing one should be updated
data

A list with named elements, containing mime data
object

An object of class "display_data"
embedded

A logical value, whether the help page should be shown embedded in the Jupyter notebook
include_button

A logical value, whether to include a button that opens a new tab for the help page.

Value

An object of class "display_data"

Methods (by class)

  • display_data(Widget): Method for jupyter widgets

  • display_data(default): Default method

  • display_data(htmlwidget): S3 method for html widgets

  • display_data(display_data): S3 method for "display_data" objects

  • display_data(update_display_data): S3 method for "update_display_data" objects

  • display_data(svg): S3 method for "svg" objects

  • display_data(data.frame): S3 method for class 'data.frame'

  • display_data(data.set): S3 method for class 'data.set'

  • display_data(importer): S3 method for class 'importer'

  • display_data(descriptions): S3 method for class 'descriptions'

  • display_data(matrix): S3 method for matrices

  • display_data(html_elem): S3 method for "html_elem" objects (see html)

  • display_data(shiny.tag): S3 methods for "shiny.tab" objects

  • display_data(shiny.tag.list): S3 methods for "shiny.tab.list" objects

  • display_data(iframe): S3 methods for "iframe" objects

  • display_data(htmlTable): S3 methods for "htmlTable" objects

  • display_data(tableHTML): S3 methods for "tableHTML" objects

  • display_data(help_files_with_topic): S3 method for help pages

  • display_data(hsearch): S3 method for results of 'help.search()'

Methods (by generic)

  • update(display_data): "update" method for "display_data" objects

Get the id of an object display

Description

This function returns the id of an object created by display_data() or update_display_data().

Usage

display_id(x)

## S3 method for class 'display_data'
display_id(x)

## S3 method for class 'update_display_data'
display_id(x)

Arguments

x

An object of class "display_data" or "update_display_data"

Value

a character string with the id.

Methods (by class)

  • display_id(display_data): S3 method for "display_data" objects

  • display_id(update_display_data): S3 method for "update_display_data" objects

A Base Class for DOM Widgets

Description

This is a base class for all widgets that are supposed to be part of the document object model

Usage

DOMWidget(...)

Arguments

...

Arguments passed to the inializer

Functions

  • DOMWidget(): The DOM widget constructor function

Super classes

RKernel::HasTraits -> RKernel::Widget -> DOMWidget

Public fields

_model_module

Name of the Javascript module with the model

_model_module_version

Version of the module where the model is defined

_model_name

Name of the Javascript model in the frontend

_dom_classes

A set of character strings that indicate the DOM classes the widget is assigned to

layout

The layout, a "LayoutClass" Widget

Methods

Public methods

Inherited methods

Method add_class()

Add a class attribute to the DOM element

Usage
DOMWidgetClass$add_class(className)
Arguments
className

Name of the class attribute

Method remove_class()

Remove a class attribute to the DOM element

Usage
DOMWidgetClass$remove_class(className)
Arguments
className

Name of the class attribute

Method has_class()

Check whether the DOM element has a class attribute

Usage
DOMWidgetClass$has_class(className)
Arguments
className

Name of the class attribute

Method clone()

The objects of this class are cloneable with this method.

Usage
DOMWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Environment Browser Widgets

Description

This function returns a widget that allows to browse within an environment

Usage

envBrowser(
  pos = -1,
  name = NULL,
  envir,
  parent = NULL,
  all.names = FALSE,
  pattern = NULL,
  mode = "any"
)

Arguments

pos

integer indicating the search position, or -1 for the current environment.
name

optional name indicating a position in the search path, see ls.
envir

environment to use, see ls.
parent

an optional parent environment.
all.names

logical; if true names starting with '.' are not omitted, see ls.
pattern

an optional pattern of names to restrict browsing to, see ls.
mode

an optional string indicating the mode of objects to which browsing is restricted, see ls.

A Manager for Comms

Description

Objects of this class are used internally to manage events, they are not meant to be used by end-users.

Usage

EventManager(...)

Arguments

...

Arguments passed to the inializer

Functions

  • EventManager(): The constructor function, returns an Object of Class "EventManagerClass"

Methods

Public methods

Method new()

Initialize an event manager

Usage
EventManagerClass$new(type)
Arguments
type

A string, the type of event (e.g. "print")

Method send()

Send an event

Usage
EventManagerClass$send(event, ...)
Arguments
event

A string, the name of an event

...

Other arguments, sent to the event handler(s)

Method on()

Install a handler for an event

Usage
EventManagerClass$on(event, handler, remove = FALSE)
Arguments
event

A string, the name of an event

handler

A function

remove

A logical value, whether the handler is to be removed

Method activate()

Activate handlers

Usage
EventManagerClass$activate(event = NULL, all = TRUE)
Arguments
event

A string, the name of an event, ignored if 'all' is TRUE.

all

A logical value, if TRUE, all handlers that belong to the event type of the event manager are activated.

Method suspend()

Suspend handlers

Usage
EventManagerClass$suspend(event = NULL, all = TRUE)
Arguments
event

A string, the name of an event, ignored if 'all' is TRUE.

all

A logical value, if TRUE, all handlers that belong to the event type of the event manager are suspended.

Method clear()

Clear (i.e. remove) handlers for an event

Usage
EventManagerClass$clear(event)
Arguments
event

A string, the name of an event

Method resume()

Resume (i.e. reactivate) an event handler

Usage
EventManagerClass$resume()

Method has()

Check whether the event manager has handlers for the given events

Usage
EventManagerClass$has(events)
Arguments
events

A character vector with names of events

Method clone()

The objects of this class are cloneable with this method.

Usage
EventManagerClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

File Upload Widgets

Description

Class and constructor for file upload widgets

Usage

FileUpload(...)

Arguments

...

Any arguments used to initialize the fields of the object

Functions

  • FileUpload(): The FileUpload constructor function

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> FileUpload

Public fields

_model_name

Name of the Javascript model in the frontend.

_view_name

Name of the Javascript view in the frontend.

accept

A character string that defineds the accepted file type. If empty, all files are accepted.

multiple

A Boolean traitlet, whether multiple files are accepted.

disabled

A Boolean traitlet, whether the widget is disabled.

icon

A character string, the font-awesome without the 'fa-' prefix.

button_style

The string that describes the button style

style

The button style, an object of class "ButtonStyleClass".

error

A string with an error message, if applicable.

value

The uploaded data.

Active bindings

filename

A character string, the name of the uploaded file.

contents

A raw vector with the contents of the uploaded file

Methods

Public methods

Inherited methods

Method new()

A generic initializer function

Usage
FileUploadClass$new(description = "Upload", ...)
Arguments
description

The button description

...

Any arguments used to initialize the fields of the object

Method handle_buffers()

Handle buffers in message

Usage
FileUploadClass$handle_buffers(msg)
Arguments
msg

A comm message

Method clone()

The objects of this class are cloneable with this method.

Usage
FileUploadClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Adapt an localhost URL so that it works from behind Jupyterhub

Description

Adapt an localhost URL so that it works from behind Jupyterhub

Usage

fix_localhost(url)

Arguments

url

A character string

Fixed Arguements in Interactive Widgets

Description

The function 'Fixed' returns ist argument marked with a class attribute "Fixed", so that it is not made into a widget when passed to Interactive

Usage

Fixed(x)

Arguments

x

An object.

Floating Point Number Traitlets

Description

A class and a constructor function to create floating point vector trait(let)s.

Usage

Float(...)

## S3 method for class 'Float'
as.integer(x, ...)

## S3 method for class 'Float'
as.numeric(x, ...)

Arguments

...

Other arguments.
x

A floating point traitlet.

Super class

RKernel::Trait -> Float

Public fields

value

A numeric vector.

optional

Logical value, whether a length-zero value is allowed.

coerce

Logical value, whether assignments to the value field should be coerced to the appropriate type.

length

Integer number, the length the value should have.

Methods

Public methods

Inherited methods

Method validator()

Check the value assigned to the traitlet.

Usage
FloatClass$validator(value)
Arguments
value

The value assigned to the traitlet.

Method new()

Initialize the traitlet.

Usage
FloatClass$new(
  initial = numeric(0),
  coerce = TRUE,
  optional = length(initial) == 0,
  length = 1L
)
Arguments
initial

A numeric vector, the initial value for the traitlet.

coerce

coerce Logical value, whether assignments to the value field should be coerced to the appropriate type.

optional

Logical value, whether a length-zero value is allowed.

length

Integer number, the length the value should have.

Method clone()

The objects of this class are cloneable with this method.

Usage
FloatClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Widgets for Text Elements with Floating Point Numbers

Description

An R6 class and a constructor function for the creation of widgets that can be used to manipulate floating point numbers.

Usage

FloatText(value = 0, step = 0.1, ...)

Arguments

value

Initial value of the floating point number.
step

Increment by which the number is increased or decreased by the text field controls.
...

Other arguments.

Details

The function FloatText creates objects of the R6 Class "FloatTextClass", which in turn have the S3 class attribute "FloatText".

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::FloatWidget -> FloatText

Public fields

_model_name

Name of the Javascript model in the frontend.

_view_name

Name of the Javascript view in the frontend.

disabled

A Boolean traitlet, whether the text widget is disabled.

continuous_update

A Boolean traitlet, whether the text widget is continuously updated upon change in the frontend.

step

A Float traitlet, a step size by which the value is incremented or decremented if the arrows are clicked.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
FloatTextClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Widgets for Floating Point Numbers

Description

An R6 class and a constructor function for the creation of widgets that can be used to manipulate floating point numbers

Usage

FloatWidget(value, ...)

Arguments

value

The floating point value
...

Other arguments, passed to the superclass initializer

Details

The function FloatWidget creates objects of the R6 Class "FloatWidgetClass", which in turn have the S3 class attribute "FloatWidget"

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> FloatWidget

Public fields

value

A Float traitlet

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
FloatWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Provide completion for code given at point.

Description

Provide completion for code given at point.

Usage

get_completions(code, cursor_pos)

Arguments

code

A character string with code to be checked for completions.
cursor_pos

An integer, the current position of the cursor.

Check whether a handler exists for URLs that have 'slug' as path component.

Description

Check whether a handler exists for URLs that have 'slug' as path component.

Usage

has_http_handler(slug)

Arguments

slug

The first part (slug) of the URL to be handled

The Base Class of Objects with Traits

Description

Objects in class HasTraits have traits as components that are correctly initialized using delayed construction with the TraitInstance function.

Public fields

call

The generating call

traits

A list of traits

suspended

Logical value; whether notifying observers is suspended.

observers

A list of observers, i.e. callback functions called by the notify method.

Methods

Public methods

Method new()

Initialize an object

Usage
HasTraits$new(...)
Arguments
...

Initializsing values

Method notify()

Notify observers about a trait being set to a value.

Usage
HasTraits$notify(tn, value)
Arguments
tn

A string, the name of the trait.

value

The value to which the trait is set.

Method observe()

Install or remove an observer function.

Usage
HasTraits$observe(tn, observer, remove = FALSE)
Arguments
tn

A string, the name of a trait.

observer

A callback function, which should take three arguments, (1) the trait name, (2) the object that has the trait, (3)

remove

A logical value, indicates whether the observer is to be removed or added

Method validate()

Install or remove the validator function of a trait.

Usage
HasTraits$validate(tn, validator, remove = FALSE)
Arguments
tn

A string, the name of a trait.

validator

A callback function

remove

A logical value, indicates whether the validator is to be removed or added

Method clone()

The objects of this class are cloneable with this method.

Usage
HasTraits$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Start interactive help system

Description

A variant of help.start that works when called from inside a Jupyter notebook.

Usage

help.start(
  update = FALSE,
  gui = "irrelevant",
  browser = getOption("browser"),
  remote = NULL
)

Arguments

update

A logical value. This formal argument exists for compatibility reasons only.
gui

A character string. This formal argument exists for compatibility reasons only.
browser

A character string. This formal argument exists for compatibility reasons only.
remote

A character string. This formal argument exists for compatibility reasons only.

Handle requests with slug "data".

Description

These request can be used to get the value of an R object, usually a data frame.

Usage

http_data(path, query, ...)

Arguments

path

The url, excluding the hostname and port, but including the slug "data" and the name of an R object.
query

The query string translated into a character vector. The value of the "format" query parameter should be one of "deparse", "str", "raw", "cat", "json", or "print". The query parameters "rows" and "cols" can be used to select rows and columns.
...

Any other arguments, ignored.

Examples

## Not run: 
  browseURL(paste0(httpd_url(),"/data/iris?rows=1-5&format=json"))

## End(Not run)

Handle requests with slug "echo".

Description

A GET request from URL 'http://localhost:XYZ/echo' will just return the request.

Usage

http_echo(path, query, ...)

Arguments

path

The url, excluding the hostname and port. Will be "/echo".
query

The query string translated into a character vector.
...

Any other arguments, ignored.

Handle requests with slug "eval".

Description

These request can be used to have R evaluate an expression

Usage

http_eval(path, query, ...)

Arguments

path

The url, excluding the hostname and port.
query

The query string translated into a character vector. The query argument named "expr" will be parsed and evaluated in a temporary environment. The result of evaluated expression will be shown in a format specified by the "format" query parameter. The value of the "format" query parameter should be one of "deparse", "str", "raw", "cat", "json", or "print".
...

Any other arguments, ignored.

Examples

## Not run: 
 browseURL(paste0(httpd_url(),"/eval?expr=Sys.time()&format=json"))

## End(Not run)

Send a GET request to an URL and read the response.

Description

Send a GET request to an URL and read the response.

Usage

http_get(x)

Arguments

x

A character string with an URL.

Examples

http_get(paste0(httpd_url(),"/data/iris?rows=1-5&format=json"))

Check whether HTTP requests are proxied. This is the case if the kernel is started from Jupyterhub and the Python package "jupyter_server_proxy" is installed.

Description

If requests are proxied and the HTTP server of the R session listens at port '<PORT>' then the appropriate URL is of the form '<JUPYTERHUB_SERVICE_PREFIX>/proxy/<PORT>' in addition to (or instead of) 'http://localhost:<PORT>'.

Usage

http_is_proxied()

Add a message to the log of HTTP requests

Description

This is intended to be used internally.

Usage

http_log(msg)

Arguments

msg

A character string

Handle a generic message request sent via getting from an url with the slug 'msg'.

Description

Handle a generic message request sent via getting from an url with the slug 'msg'.

Usage

http_msg(path, query, ...)

Arguments

path

The url, excluding the hostname and port, but including the slug "data" and the name of an R object.
query

The query string translated into a character vector.
...

Any other arguments, ignored.

Get the port of the HTTP server.

Description

Get the port of the HTTP server.

Usage

httpd_port()

Get the port the HTTP server listens to.

Description

Get the port the HTTP server listens to.

Usage

httpd_url()

Include HTML content using in an iframe

Description

Display the contents of a webpage or other HTML content by including output using an [iframe](https://html.spec.whatwg.org/multipage/iframe-embed-object.html).

Usage

IFrame(url, width = "100%", height = "70ex", class = NULL, srcdoc = FALSE)

Arguments

url

A character string, the URL of the content to be included
width

A character string that specifies the width of the iframe
height

A character string that specifies the width of the iframe
class

An optional character string with DOM classes to be assigned to the iframe.
srcdoc

Logical, whether to use a 'src' (FALSE, the default) or 'srcdoc' attribute.

install the R Kernel

Description

install the R Kernel

Usage

install(...)

installspec(
  user = TRUE,
  prefix = NULL,
  kernel_name = "rkernel",
  display_name = "R",
  env = NULL
)

Arguments

...

Arguments passed on to installspec
user

Logical, whether to install the kernel in the user's home directory
prefix

NULL or a character string with a path prefix
kernel_name

String; the name of the kernel. To be used e.g. as the '–kernel=' argument for the CLI call 'jupyter console'
display_name

String; the name as it appears in the Jupyter web interface
env

A list or NULL; optional environmental variables for the R kernel process. For example, to get single-threaded open-blas use "env = list(OPENBLAS_NUM_THREADS = 1)". To force a single OMP thread use "env = list(OMP_NUM_THREADS = 1)"

Functions

  • installspec(): Install the R Kernel spec

Integer Traitlets

Description

A class and a constructor function to create integer vector trait(let)s.

Usage

Integer(...)

## S3 method for class 'Integer'
as.integer(x, ...)

## S3 method for class 'Integer'
as.numeric(x, ...)

## S3 method for class 'Integer'
to_json(x, ...)

Arguments

...

Other arguments.
x

An integer traitlet.

Super class

RKernel::Trait -> Integer

Public fields

value

An integer vector.

optional

Logical value, whether a length-zero value is allowed.

coerce

Logical value, whether assignments to the value field should be coerced to the appropriate type.

length

Integer number, the length the value should have.

Methods

Public methods

Inherited methods

Method validator()

Check the value assigned to the traitlet.

Usage
IntegerClass$validator(value)
Arguments
value

The value assigned to the traitlet.

Method new()

Initialize the traitlet.

Usage
IntegerClass$new(
  initial = integer(0),
  coerce = TRUE,
  optional = length(initial) == 0,
  length = 1L
)
Arguments
initial

An integer vector, the initial value for the traitlet.

coerce

coerce Logical value, whether assignments to the value field should be coerced to the appropriate type.

optional

Logical value, whether a length-zero value is allowed.

length

Integer number, the length the value should have.

Method clone()

The objects of this class are cloneable with this method.

Usage
IntegerClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Interactions Using Widgets

Description

A variety of functions to create interactive function calls

Usage

interactive_output(
  FUN,
  controls,
  out,
  button = NULL,
  continuous_update = TRUE,
  autorun = TRUE,
  clear = FALSE,
  mime_type = "text/plain"
)

mkWidgets(...)

Interactive(
  FUN,
  ...,
  continuous_update = TRUE,
  append_output = FALSE,
  use_display = TRUE
)

interact(
  FUN,
  ...,
  continuous_update = TRUE,
  append_output = FALSE,
  use_display = TRUE
)

Arguments

FUN

A function to called with arguments manipulated using interactive widgets.
controls

A list of controlling widgets, usually created with the function mkwidgets
out

An output widget, i.e. a widget in class "OutputWidget"
button

An (optional) button widget; when clicked, the function FUN is called.
continuous_update

A logical value, if TRUE the function FUN is called whenever one of the controlling widgets changes a value
autorun

Logical, whether the function FUN will be automatically called when any of the controlling widget values is changed or only when button is clicked.
clear

Logical, whether out is cleared before each call of FUN.
mime_type

A character string that specifies the mime type as which the return value of FUN is displayed.
...

Named arguments, transformed into widgets using the generic function mkWidget.
append_output

Logical, whether existing output should be appended to or overwritten.
use_display

Logical, whether the display mechanism is used internally for output streams.

Widgets for Text Elements with Integer Numbers

Description

An R6 class and a constructor function for the creation of widgets that can be used to manipulate integer numbers

Usage

IntText(value = 0, step = 1, ...)

Arguments

value

Initial value of the integer number
step

Increment by which the number is increased or decreased by the text field controls
...

Arguments passed to the superclass constructor

Details

The function IntText creates objects of the R6 Class "IntTextClass", which in turn have the S3 class attribute "IntText"

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::IntWidget -> IntText

Public fields

_model_name

Name of the Javascript model in the frontend.

_view_name

Name of the Javascript view in the frontend.

disabled

A Boolean traitlet, whether the text widget is disabled.

continuous_update

A Boolean traitlet, whether the text widget is continuously updated upon change in the frontend.

step

An Integer traitlet, a step size by which the value is incremented or decremented if the arrows are clicked.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
IntTextClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Widgets for Integer Numbers

Description

An R6 class and a constructor function for the creation of widgets that can be used to manipulate integer numbers.

Usage

IntWidget(value, ...)

Arguments

value

The integer value.
...

Other arguments, passed to the superclass initializer.

Details

The function IntWidget creates objects of the R6 Class "IntWidgetClass", which in turn have the S3 class attribute "IntWidget".

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> IntWidget

Public fields

value

A Integer traitlet.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
IntWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Send Javascript to the frontend

Description

Send Javascript code in a character string or a text file to the frontend.

Usage

Javascript(text, file, as_tag = FALSE)

Arguments

text

A character string with Javascript code
file

Path of a file with Javascript code
as_tag

Logical, whether to return a '<script>' tag

Value

An S3 object of class "display_data" with mime data of type "application/javascript"

The Kernel Class

Description

An object of this class handles the low-level communication with the Jupyter frontend or kernel manager. There should only be one object of this class in existence.

Public fields

session

See RKernelSession.

repl

An RSessionAdapter for handling input and output

runner

An RSessionRunner

DAPServer

The current DAP server

errored

Logical, whether an error occurred in the R session

stop_on_error

Logical, whether running a notebook should be stopped in case of an error in the R session.

Methods

Public methods

Method new()

Initialize the kernel

Usage
Kernel$new(conn_info)
Arguments
conn_info

A list with the connection info from the front-end

Method start()

Start the R session and other components

Usage
Kernel$start()

Method run_code()

Run some code (for testing purposes)

Usage
Kernel$run_code(code, debug = FALSE)
Arguments
code

Some code

debug

Logical, whether running a code cell should occur under debugging conditions

Method run()

Run the kernel.

Usage
Kernel$run()

Method poll_and_respond()

A single iteration of the kernel loop

Usage
Kernel$poll_and_respond(
  poll_timeout = getOption("rkernel_poll_timeout", 10L),
  drop = NULL
)
Arguments
poll_timeout

An integer

drop

Logical, whether execute requests should be dropped

Method clear_output()

Clear the current output cell in the frontend.

Usage
Kernel$clear_output(wait)
Arguments
wait

Logical value, whether to wait until output is cleared.

Method stream()

Stream text to the frontend.

Usage
Kernel$stream(text, stream)
Arguments
text

Text to be sent to the frontend

stream

A string to select the stream – either "stout" or "stderr"

Method stdout()

Stream text to the frontend via 'stdout' stream.

Usage
Kernel$stdout(text)
Arguments
text

Text to be sent to the frontend.

Method stderr()

Stream text to the frontend via 'stderr' stream.

Usage
Kernel$stderr(text)
Arguments
text

Text to be sent to the frontend.

Method readline()

Ask the frontend for a line of text input.

Usage
Kernel$readline(prompt = "")
Arguments
prompt

The prompt, a character string.

Method execute_result()

Send execution results to the frontend

Usage
Kernel$execute_result(data, metadata = emptyNamedList)
Arguments
data

Execution result in rich format

metadata

A list with metadata

Method display_send()

Send rich format data to the frontend

Usage
Kernel$display_send(msg)
Arguments
msg

A list with the appropriate structure. [TODO]

Method send_error()

Send an error message and traceback to the frontend.

Usage
Kernel$send_error(name, value, traceback)
Arguments
name

A string, the error name.

value

A string, the value of the error message.

traceback

A character vector with the traceback.

Method send_comm()

Send a message via a comm.

Usage
Kernel$send_comm(msg)
Arguments
msg

A list containing a comm message.

Method get_parent()

The parent of the message currently sent.

Usage
Kernel$get_parent(channel = "shell")
Arguments
channel

A string, the relevant input channel.

Method get_conn_info()

Return the current connection info.

Usage
Kernel$get_conn_info()

Method is_child()

Check if the current process is a fork from the original kernel process

Usage
Kernel$is_child()

Method input_request()

Send an input request to the frontend

Usage
Kernel$input_request(prompt = "", password = FALSE)
Arguments
prompt

A prompt string

password

Logical value; whether the input should be hidden like in a password dialog

Method read_stdin()

Read a line from the frontend

Usage
Kernel$read_stdin()

Method send_debug_event()

Send a debug event to the frontend

Usage
Kernel$send_debug_event(content)
Arguments
content

A list, content provided by the debug adapter

Method save_shell_parent()

Save the parent message on the shell channel

Usage
Kernel$save_shell_parent()

Method restore_shell_parent()

Restore a saved parent message on the shell channel.

Usage
Kernel$restore_shell_parent(saved_parent)
Arguments
saved_parent

A saved parent message, a list.

Method shutdown()

Shut down the kernel and all associated sub-process i.e. the R session and all detached-cell processes.

Usage
Kernel$shutdown()

Method restart()

Restart the R session

Usage
Kernel$restart()

Method restore_execute_parent()

Restore parent message of last execute_request.

Usage
Kernel$restore_execute_parent()

Method handle_yield()

Handle R session's yielding to allow servicing frontend requests

Usage
Kernel$handle_yield(timeout)
Arguments
timeout

Number of milliseconds to wait for a frontend request

Method add_service()

Add a function as a service to be run each iteration of the kernel loop.

Usage
Kernel$add_service(FUN)
Arguments
FUN

A function.

Method clone()

The objects of this class are cloneable with this method.

Usage
Kernel$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Send LaTeX math to the frontend

Description

Send LaTeX code for math in a character string to the frontend to be formatted by MathJax

Usage

LaTeXMath(text)

Arguments

text

A character string with LaTeX code for math

Widget Layout Manipulation

Description

An R6 class and a constructor function for the creation of a layout widget, which itself is used to manipulate the layout of a DOMWidget.

Usage

Layout(...)

Arguments

...

Arguments passed to the inializer

Details

The function Layout creates objects of the R6 Class "LayoutClass", which in turn have the S3 class attribute "Layout"

Functions

  • Layout(): The Layout constructor function

Super classes

RKernel::HasTraits -> RKernel::Widget -> Layout

Public fields

_view_name

Name of the Javascript view in the frontend.

_view_module

Name of the Javascript view module in the frontend.

_view_module_version

Version of the Javascript view module in the frontend.

_model_name

Name of the Javascript model in the frontend.

align_content

An optional string, if non-empty, one of "flex-start", "flex-end", "center", "space-between", "space-around", "space-evenly", "stretch"

align_items

An optional string, if non-empty, one of "flex-start", "flex-end", "center", "baseline", "stretch"

align_self

An optional string, if non-empty, one of "flex-start", "flex-end", "center", "baseline", "stretch"

bottom

Position from bottom, an optional string that should, if non-empty, contain a valid CSS dimension

border

An optional string with a valid CSS border specification

border_top

An optional string with a valid CSS border specification

border_right

An optional string with a valid CSS border specification

border_bottom

An optional string with a valid CSS border specification

border_left

An optional string with a valid CSS border specification

display

An optional string with a valid CSS display property

flex

An optional string with a valid CSS flex property

flex_flow

An optional string with a valid CSS flex_flow property

height

An optional string with a valid CSS height

justify_content

An optional string, if non-empty, one of "flex-start", "flex-end", "center", "space-between", "space-around".

justify_items

An optional string, if non-empty, one of "flex-start", "flex-end", or "center"

left

Position from left, an optional string that should, if non-empty, contain a valid CSS dimension

margin

An optional string, if non-empty, should be a valid CSS margin specification

max_height

An optional string, if non-emtpy, should be a valid CSS dimension

max_width

An optional string, if non-emtpy, should be a valid CSS dimension

min_height

An optional string, if non-emtpy, should be a valid CSS dimension

min_width

An optional string, if non-emtpy, should be a valid CSS dimension

overflow

An optonal string, if non-empty, should be a valid CSS overflow specification

order

An optional string, if non-empty should contain a number

padding

An optional string, if non-emtpy should be a valid CSS dimension

right

Position from right, an optional string, if non-empty, should be a valid CSS dimension

top

Position from top, an optional string, if non-empty, should be a valid CSS dimension

visibility

An optional string, if non-empty, should be either "visible" or "hidden"

width

An optional string, if non-empty, should be a valid CSS dimension

object_fit

An optional string, if non-empty, should be one of "contain", "cover", "fill", "scale-down", "none"

object_position

An optional string, if non-empty, should be a valid CSS object-position specification

grid_auto_columns

An optional string, if non-empty should be valid CSS code for the grid-auto-columns property

grid_auto_flow

An optional string, if non-empty should be valid CSS code for the grid-auto-flow property

grid_auto_rows

An optional string, if non-empty should be valid CSS code for the grid-auto-rows property

grid_gap

An optional string, if non-empty should be valid CSS code for the grid-gap property

grid_template_rows

An optional string, if non-empty should be valid CSS code for the grid-template-rows property

grid_template_columns

An optional string, if non-empty should be valid CSS code for the grid-template-columns property

grid_template_areas

An optional string, if non-empty should be valid CSS code for the grid-template-areas property

grid_row

An optional string, if non-empty should be valid CSS code for the grid-row property

grid_column

An optional string, if non-empty should be valid CSS code for the grid-column property

grid_area

An optional string, if non-empty should be valid CSS code for the grid-area property

Methods

Public methods

Inherited methods

Method observe_border()

Synchronize border traits

Usage
LayoutClass$observe_border(nm, self, value)
Arguments
nm

Name of the trait (a dummy argument)

self

The object

value

A CSS string

Method new()

Initialize an object

Usage
LayoutClass$new(...)
Arguments
...

Arguments passed to the superclass initializer

Method clone()

The objects of this class are cloneable with this method.

Usage
LayoutClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Widget Layout Templates

Description

R6 classes and constructor functions for widget layout templates

Usage

AppLayout(...)

GridspecLayout(...)

## S3 method for class 'GridspecLayout'
x[i, j, ..., drop = TRUE]

## S3 replacement method for class 'GridspecLayout'
x[i, j] <- value

TwoByTwoLayout(...)

Arguments

...

Arguments used to initialize the fields
x

A GridspecLayout object
i

Integer value(s) referring to the row(s)
j

Integer value(s) referring to the column(s)
drop

Logical, whether the result is a widget or a list with one element if both i an j select a single element
value

One or more widgets put at the idicated positions in the grid

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::Box -> RKernel::GridBox -> TemplateBase

Public fields

grid_gap

The grid-gap CSS attribute

justify_content

The justify-content CSS attribute

align_items

The align-items CSS attribute

width

The width CSS attribute

height

The height CSS attribute

Methods

Public methods

Inherited methods

Method new()

Initializer

Usage
TemplateBaseClass$new(...)
Arguments
...

Arguments used to initialize the fields

Method clone()

The objects of this class are cloneable with this method.

Usage
TemplateBaseClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::Box -> RKernel::GridBox -> RKernel::TemplateBase -> AppLayout

Public fields

header

Widget that appears in the header section

footer

Widget that appears in the footer section

left_sidebar

Widget that appears as left sidebar

right_sidebar

Widget that appears as right sidebar

center

Widget that appears in the center section

pane_widths

Unicode string with CSS widths for the app panes

pane_heights

Unicode string with CSS heights for the app panes

merge

Boolean, whether space of missing widgets chould be merged

Methods

Public methods

Inherited methods

Method new()

Initializer method

Usage
AppLayoutClass$new(...)
Arguments
...

Arguments, passed on to the superclass initializer

Method clone()

The objects of this class are cloneable with this method.

Usage
AppLayoutClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::Box -> RKernel::GridBox -> RKernel::TemplateBase -> GridspecLayout

Methods

Public methods

Inherited methods

Method new()

Initializer function

Usage
GridspecLayoutClass$new(nrow, ncol, ...)
Arguments
nrow

A positive integer, the number of rows

ncol

A positive integer, the number of columns

...

Other arguments, passed to the superclass initializer

Method set_item()

Set widget in grid cells

Usage
GridspecLayoutClass$set_item(i, j, value)
Arguments
i

The rows into which the widget is to be placed

j

The columns into which the widget is to be placed

value

A widget

Method get_item()

Get widget from grid cells

Usage
GridspecLayoutClass$get_item(i, j)
Arguments
i

The rows where the widget is located

j

The columns where the widget is located

Method clone()

The objects of this class are cloneable with this method.

Usage
GridspecLayoutClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::Box -> RKernel::GridBox -> RKernel::TemplateBase -> TwoByTwoLayout

Public fields

top_left

Widget that appears on the top left

top_right

Widget that appears on the top right

bottom_left

Widget that appears on the bottom left

bottom_right

Widget that appears on the bottom right

merge

Boolean, whether space of missing widgets chould be merged

Methods

Public methods

Inherited methods

Method new()

Initializer method

Usage
TwoByTwoLayoutClass$new(...)
Arguments
...

Arguments, passed on to the superclass initializer

Method clone()

The objects of this class are cloneable with this method.

Usage
TwoByTwoLayoutClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

List Traitlets

Description

A class and a constructor function to create list trait(let)s.

Usage

List(...)

Arguments

...

Arguments that are passed to the initialize method of 'ListClass'

Super class

RKernel::Trait -> List

Public fields

value

A list

Methods

Public methods

Inherited methods

Method validator()

A function that checks the validity of an assigned value, i.e. whether the assigned value is a list

Usage
ListClass$validator(value)
Arguments
value

A value to be assigned as the traitlet value

Method clone()

The objects of this class are cloneable with this method.

Usage
ListClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

A HTML version of 'ls.str()'

Description

This function is now just an alias for envBrowser.

Usage

ls_str(
  pos = -1,
  name = NULL,
  envir,
  all.names = FALSE,
  pattern = NULL,
  mode = "any"
)

Arguments

pos

integer indicating search path position, or -1 for the current environment.
name

an optional name indicating search path position, see ls.
envir

the environment to look into
all.names

logical value, if FALSE objects with names that start with a dot are ignored
pattern

a character string, the pattern of the names of the objects to show
mode

a character string, the mode of the objects to be shown

See Also

ls.str

Main entry point of the package

Description

This function reads the connection info file, creases a "Kernel" object and runs it, i.e. starts the kernel.

Usage

main()

Media widgets

Description

Classes and constructors to wrap media into widgets

Usage

ImageWidget(...)

VideoWidget(...)

AudioWidget(...)

Arguments

...

Any arguments used to initialize the fields of the object

Functions

  • ImageWidget(): The ImageWidget constructor function

  • VideoWidget(): The VideoWidget constructor function

  • AudioWidget(): The AudioWidget constructor function

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> MediaWidget

Public fields

format

A string, giving the graphics fromat.

value

A Bytes traitlet.

Methods

Public methods

Inherited methods

Method from_url()

Create media widget from url

Usage
MediaWidgetClass$from_url(url, width = NULL, height = NULL)
Arguments
url

A character string

width

A character string with CSS width specification

height

A character string with CSS height specification

Method from_file()

Create media widget from file

Usage
MediaWidgetClass$from_file(filename)
Arguments
filename

A character string

Method on_change()

Add or remove a handler to be called if value is changed.

Usage
MediaWidgetClass$on_change(handler, remove = FALSE)
Arguments
handler

A function that is called when the button is clicked.

remove

Logical value, whether the handler is to be removed.

Method new()

Initialize an object

Usage
MediaWidgetClass$new(from_file = NULL, from_url = NULL, ...)
Arguments
from_file

An optional character string, name of the file from which to initialize the widget.

from_url

An optional character string, URL from which to initialize the widget.

...

Other arguments, passed to the superclass initializer.

Method clone()

The objects of this class are cloneable with this method.

Usage
MediaWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::MediaWidget -> ImageWidget

Public fields

_view_name

Name of the Javascript view in the frontend.

_model_name

Name of the Javascript model in the frontend.

format

A string, giving the graphics fromat.

width

A string, describing the width in CSS language, e.g. "480px".

height

A string, describing the height in CSS language, e.g. "480px".

Methods

Public methods

Inherited methods

Method from_file()

Create image widget from file

Usage
ImageWidgetClass$from_file(filename, width = NULL, height = NULL)
Arguments
filename

A character string

width

A character string with CSS width specification

height

A character string with CSS height specification

Method clone()

The objects of this class are cloneable with this method.

Usage
ImageWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::MediaWidget -> VideoWidget

Public fields

_view_name

Name of the Javascript view in the frontend.

_model_name

Name of the Javascript model in the frontend.

format

A string, giving the video fromat.

width

A string, describing the width in CSS language, e.g. "480px".

height

A string, describing the height in CSS language, e.g. "480px".

autoplay

Boolean, when TRUE the video starts when it is displayed.

loop

Boolean, when TRUE the video restarts after finishing.

controls

Boolean, when TRUE then video controls are shown.

Methods

Public methods

Inherited methods

Method from_file()

Create image widget from file

Usage
VideoWidgetClass$from_file(filename, width = NULL, height = NULL)
Arguments
filename

A character string

width

A character string with CSS width specification

height

A character string with CSS height specification

Method clone()

The objects of this class are cloneable with this method.

Usage
VideoWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::MediaWidget -> AudioWidget

Public fields

_view_name

Name of the Javascript view in the frontend.

_model_name

Name of the Javascript model in the frontend.

format

A string, giving the audio fromat.

autoplay

Boolean, when TRUE the video starts when it is displayed.

loop

Boolean, when TRUE the video restarts after finishing.

controls

Boolean, when TRUE then video controls are shown.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
AudioWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Controls for Interactive Widgets

Description

A set of functions that can be used to create interactive widgets and to interact with widgets.

Usage

mkWidget(x, ...)

## S3 method for class 'integer'
mkWidget(x, description = NULL, ...)

## S3 method for class 'numeric'
mkWidget(x, description = NULL, ...)

## S3 method for class 'logical'
mkWidget(x, description = NULL, ...)

## S3 method for class 'character'
mkWidget(x, description = NULL, ...)

## S3 method for class 'Fixed'
mkWidget(x, ...)

## S3 method for class 'ValueWidget'
mkWidget(x, ...)

Arguments

x

an object
...

Other arguments, passed to more specific methods or ignored
description

NULL or a character string that contains a description.

Details

The function mkWidget is a generic function that creates a widget that allows to manipulate the arguments of a function that is called in an interactive widget. This generic function is called by the function mkWidgets. The function Fixed marks a value as fixed, so that mkWidget returns it as is.

Widgets to receive output

Description

Classes and constructors to wrap output created by code

Usage

OutputWidget(append_output = FALSE, ...)

## S3 method for class 'OutputWidget'
with(data, expr, envir = list(), enclos = parent.frame(), clear = TRUE, ...)

Arguments

append_output

Logical value, whether new output is appended to existing output in the widget or the output is overwritten
...

Other arguments, ignored.
data

An "OutputWidget" object
expr

An expression to evaluate, or a sequence of expression, encapsulated by curly braces.
envir

An environment or a list within which 'expr' is evaluated.
enclos

An enclosing environment.
clear

A logical value, whether clear the output before evaluating 'expr'

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> OutputWidget

Public fields

_view_name

Name of the Javascript model view in the frontend

_model_name

Name of the Javascript model in the frontend

_view_module

Name of the module where the view is defined

_model_module

Name of the Javascript module with the model

_view_module_version

Version of the module where the view is defined

_model_module_version

Version of the module where the model is defined

msg_id

Unicode string with the id of the last message sent to the frontend.

outputs

A list with output strings

Methods

Public methods

Inherited methods

Method new()

Initializing function

Usage
OutputWidgetClass$new(append_output = TRUE, graphics = FALSE, ...)
Arguments
append_output

Logical, whether existing output should be appended to or overwritten.

graphics

Logical, whether graphics should be captured and processed within the widget

...

Any other arguments, passed to the superclass initializer.

Method display()

A variant of display for output within a display widget.

Usage
OutputWidgetClass$display(...)
Arguments
...

Arguments passed to the function display_data.

Method clear()

Clear the output

Usage
OutputWidgetClass$clear(wait = FALSE)
Arguments
wait

Logical, whether to wait for the frontend to clear the output.

Method stdout()

Handle output via stdout stream

Usage
OutputWidgetClass$stdout(text)
Arguments
text

A character string being output

Method stderr()

Handle output via stderr stream

Usage
OutputWidgetClass$stderr(text)
Arguments
text

A character string being output

Method handle_msg()

Handle a (JSON) message sent to the output

Usage
OutputWidgetClass$handle_msg(msg)
Arguments
msg

The message, a list

Method clone()

The objects of this class are cloneable with this method.

Usage
OutputWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Display an object using the Jupyter notebook pager

Description

This function allows to display an R object in the pager of a Jupyter notebook. Note that acts like display() when Jupyter Lab is used.

Usage

Page(x, ...)

## Default S3 method:
Page(x, start = 1, ...)

Arguments

x

An object to be displayed in the Notebook pager
...

Other arguments, ignored or passed to specific methods.
start

Integer, where to start the output.

Methods (by class)

  • Page(default): S3 default method – calls display_data and marks it as pager payload

A Player Widget

Description

An R6 class and a constructor function for the creation of a player widget, which automatically increases its value-

Usage

Play(
  value = 0L,
  min = 0L,
  max = 100L,
  interval = 100L,
  step = 1L,
  show_repeat = TRUE,
  ...
)

Arguments

value

Integer, an initial value.
min

Integer, the minimum value.
max

Integer, the maximum value.
interval

Integer, the maximum value of the intrval .
step

The maximum value for the play control.
show_repeat

Logical, whether to show a repeat toggle button.
...

Further arguments, passed to the superclass constructor.

Functions

  • Play(): The player widget constructor function.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::BoundedIntWidget -> Play

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript model view in the frontend

interval

An Integer traitlet, the time interval between between two steps.

step

An Integer traitlet, the step size.

_playing

A Boolean traitlet, indicates wether the player widget is running.

playing

A Boolean traitlet, indicates wether the player widget is running.

_repeat

A Boolean traitlet, indicates wether the the repeat toggle is on.

repeat

A Boolean traitlet, indicates wether the the repeat toggle is on.

show_repeat

A Boolean traitlet, determines whether to show a repeat toggle button.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
PlayClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Widgets to receive plots graphics

Description

Class and constructors show graphics created by code

Usage

SVGWidget(...)

## S3 method for class 'SVGWidget'
with(data, expr, envir = list(), enclos = parent.frame(), ...)

PlotWidget(...)

Arguments

...

Arguments, passed to the ImageWidget constructors.
data

An "SVGWidget" object
expr

An expression to evaluate, or a sequence of expression, encapsulated by curly braces.
envir

An environment or a list within which 'expr' is evaluated.
enclos

An enclosing environment.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::StringWidget -> RKernel::HTML -> SVGWidget

Methods

Public methods

Inherited methods

Method new()

Initialize the object

Usage
SVGWidgetClass$new(..., width = NULL, height = NULL)
Arguments
...

Arguments passed to the superclass initializer

width

A character string, giving the width as a CSS property

height

A character string, giving the height as a CSS property

Method activate()

Activate widget as graphics device

Usage
SVGWidgetClass$activate()

Method suspend()

Suspend widget as graphics device

Usage
SVGWidgetClass$suspend()

Method render()

Render contents of graphics device as SVG

Usage
SVGWidgetClass$render()

Method clone()

The objects of this class are cloneable with this method.

Usage
SVGWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Progress bars

Description

Classes and constructor functions for progress bars and styling of them

Usage

ProgressStyle(...)

IntProgress(value = 0L, min = 0L, max = 100L, ...)

FloatProgress(value = 0L, min = 0L, max = 100L, ...)

Arguments

...

Other arguments.
value

A floating point number, the initial position of the progress bar
min

An floating point number, the minumum value
max

An floating point number, the maximum value

Functions

  • ProgressStyle(): A constructor for a progress bar style

  • IntProgress(): A constructor for a progress bar style

  • FloatProgress(): A constructor for a progress bar style

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DescriptionStyle -> ProgrssStyle

Public fields

_model_name

Name of the Javascript model in the frontend

bar_color

The colour of the progress bar

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
ProgressStyleClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::BoundedIntWidget -> IntProgress

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

orientation

Orientation of the progress bar, either "horizontal" or "vertical"

bar_style

General style of the progress bar, either "successs", "info", "warning" or "danger"

style

Styling of the progress bar, an instance of "ProgressStyleClass"

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
IntProgressClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::BoundedFloatWidget -> FloatProgress

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

orientation

Orientation of the progress bar, either "horizontal" or "vertical"

bar_style

General style of the progress bar, either "successs", "info", "warning" or "danger"

style

Styling of the progress bar, an instance of "ProgressStyleClass"

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
FloatProgressClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

R6 Objects That Are Not Locked

Description

This function calls the R6 class constructor in such a way that new members can be added to the created objects.

Usage

R6Class_(..., lock_objects = FALSE)

Arguments

...

Arguments passed to the superclass constructor
lock_objects

A logical value, indicates whether objects should be locked. See R6Class.

A Generic Constructor for R6 Object Traits

Description

A Generic Constructor for R6 Object Traits

Usage

R6Instance(...)

Arguments

...

Arguments passed to the trait instance initializer

A Base Class for Traits that are R6 Objects

Description

A Base Class for Traits that are R6 Objects

A Base Class for Traits that are R6 Objects

Super class

RKernel::Trait -> R6Trait

Public fields

value

An R6 object

class

The R6 class of value

Methods

Public methods

Inherited methods

Method validator()

Checks wether value has the corret class

Usage
R6TraitClass$validator(value)
Arguments
value

A value about to be assigned to the trait.

Method new()

Initialize an object

Usage
R6TraitClass$new(Class, ...)
Arguments
Class

Class of the object

...

Values used for initialization

Method clone()

The objects of this class are cloneable with this method.

Usage
R6TraitClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Send raw HTML code to the frontend

Description

Send raw HTML code in a character string to the frontend

Usage

raw_html(text, id = UUIDgenerate(), update = FALSE)

Arguments

text

A character string with LaTeX code for math
id

A character string with the display id
update

A logical value, should an existing display_data option?

Register a handler for magics

Description

Similar to ' There are pre-defined magics for LaTeX math, CSS, Javascrippt, HTML, and iframes.

Usage

register_magic_handler(magic, handler)

Arguments

magic

A character string that selects a handler
handler

A function that takes at least the argument 'code' and more '...' arguments. The latter are constructed from the arguments of the percentage magic.

Remove a Class to the 'Displayed' Ones

Description

Remove a class from those who are output using display() when they are autoprinted, i.e. returned as the value of the last expression in a Jupyter notebook cell.

Usage

remove_displayed_classes(x)

Arguments

x

A character string, the name of a class.

Remove a Class to the 'Paged' Ones

Description

Remove a class from those who are output using Page() when they are autoprinted, i.e. returned as the value of the last expression in a Jupyter notebook cell.

Usage

remove_paged_classes(x)

Arguments

x

A character string, the name of a class.

The KernelSession Class

Description

An object of this class handles the communication with an R process. There is usually one main session, but there may also sessions for detached code cells.

Super classes

processx::process -> callr::r_session -> RKernel::RSessionBase -> RKernelSession

Public fields

http_port

The port number of HTML help.

hostname

The hostname.

yield

An optional function to service kernel requests

kernel

The reference to the controlling kernel object

Methods

Public methods

Inherited methods

Method connect()

Connect the session with the main Kernel object

Usage
RKernelSession$connect(yield, kernel)
Arguments
yield

The function that is called when the session objects yields back control to the kernel object, for example in order to wait for comm message when a widget is active.

kernel

The main kernel objectd

Method setup()

Set up the R session, by installing hooks etc.

Usage
RKernelSession$setup()

Method start_graphics()

Initialize graphics, start device and return details

Usage
RKernelSession$start_graphics()

Method dev_new()

Start a httpgd device and return the graphics details.

Usage
RKernelSession$dev_new()

Method graphics_details()

Return the graphics details.

Usage
RKernelSession$graphics_details()

Method http_get()

Usage
RKernelSession$http_get(slug = "", query = "")

Method clone()

The objects of this class are cloneable with this method.

Usage
RKernelSession$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

A Rich R Session Interface

Description

Objects from this class handle the "higher-level" interaction between the frontend and the R session. There can be more such interfaces to a session. For example, for the main REPL and for a REPL created by a call to browser().

Public fields

session

An RKernelSession object or 'NULL'

prompt

The R console prompt or NULL

coprompt

The R console continuation prompt or NULL

browse_prompt

The prompt created by a call to 'browser()'

io_timeout

An integer number a timeout in microseconds

stdout

Accumulated output via the stdout channel.

stderr

Accumulated output via the stderr channel.

stdout_callback

A function to be called with stdout text or NULL

stderr_callback

A function to be called with stderr text or NULL

browser_callback

A function to be called when a browser prompt is encountered or NULL

prompt_callback

A function to be called when a command prompt is encountered or NULL

input_callback

A function to be called when input is required or NULL

echo

A logical value, if TRUE code sent to the R process will be echoed

found_prompt

A logical value, whether a prompt has been found in the output of the R process

found_browse_prompt

The latest instance of the browser prompt pattern found in the R process output

errored

A logical value, whether an error occurred in the R session

Methods

Public methods

Method aggreg_stdout()

A potential "stdout_callback" function that aggregates output sent from the R process via "stdout" channel to the eponymous "stdout" field

Usage
RSessionAdapter$aggreg_stdout(txt, ...)
Arguments
txt

A character string

...

Other arguments, ignored

Method aggreg_stderr()

A potential "stderr_callback" function that aggregates output sent from the R process via "stderr" channel to the eponymous "stderr" field

Usage
RSessionAdapter$aggreg_stderr(txt, ...)
Arguments
txt

A character string

...

Other arguments, ignored

Method collect()

Collect the accumulated output from fields "stdout" and "stderr" into a list with two elements named "stdout" and "stderr".

Usage
RSessionAdapter$collect(clear = TRUE)
Arguments
clear

A logical value, whether accumulated output should be cleared after being returned.

Method new()

Initialize an object

Usage
RSessionAdapter$new(
  session,
  stdout_callback = self$aggreg_stdout,
  stderr_callback = self$aggreg_stderr,
  browser_callback = NULL,
  prompt_callback = NULL,
  input_callback = NULL,
  prompt = "> ",
  coprompt = "+ ",
  echo = FALSE
)
Arguments
session

An object from class "RKernelSession"

stdout_callback

A callback function for "stdout" output

stderr_callback

A callback function for "stderr" output

browser_callback

A callback function for browser prompts (optional)

prompt_callback

A callback function for command prompts encountered

input_callback

A callback function for input requests (optional)

prompt

A character string, the expected command prompt

echo

A logical value, whether to echo input

Method run_code()

Run code and pass output to callback functions

Usage
RSessionAdapter$run_code(
  code,
  io_timeout = 1,
  stdout_callback = self$stdout_callback,
  stderr_callback = self$stderr_callback,
  browser_callback = self$browser_callback,
  prompt_callback = self$prompt_callback,
  input_callback = self$input_callback,
  until_prompt = TRUE,
  echo = self$echo,
  debug = FALSE
)
Arguments
code

A character string or character vector with code lines

io_timeout

An integer value, the timeout of waiting for output

stdout_callback

A callback function for "stdout" output

stderr_callback

A callback function for "stderr" output

browser_callback

A callback function for browser prompts (optional)

prompt_callback

A callback function for command prompts encountered

input_callback

A callback function for input requests (optional)

until_prompt

A logical value, whether process and wait output until a command prompt is encountered.

echo

A logical value, whether to echo input

Method interrupt()

Send an interrupt signal (SIGINT) to the R process. This should stop what the R process is doing without killing it.

Usage
RSessionAdapter$interrupt()

Method poll_output()

Usage
RSessionAdapter$poll_output(io_timeout = 1)

Method process_output()

Process output created by commands sent to the R process

Usage
RSessionAdapter$process_output(
  stdout_callback = self$stdout_callback,
  stderr_callback = self$stderr_callback,
  browser_callback = self$browser_callback,
  input_callback = self$input_callback,
  prompt_callback = self$prompt_callback,
  drop_echo = FALSE,
  debug = FALSE
)
Arguments
stdout_callback

A callback function for "stdout" output

stderr_callback

A callback function for "stderr" output

browser_callback

A callback function for browser prompts (optional)

input_callback

A callback function for input requests (optional)

prompt_callback

A callback function for command prompts encountered

drop_echo

A logical value, whether input echo be dropped

io_timeout

An integer value, the timeout of waiting for output

until_prompt

A logical value, whether process and wait output until a command prompt is encountered.

Method run_cmd()

Run a one-line command without checking and return the output

Usage
RSessionAdapter$run_cmd(cmd, debug = FALSE)
Arguments
cmd

A command string

Method getOption()

Get an option value from the R session

Usage
RSessionAdapter$getOption(n, default = NULL)
Arguments
n

A character string, the name of the requested option value

default

A default value

Method eval()

Evaluate an expression in the R session and return the result.

Usage
RSessionAdapter$eval(expr, safe = FALSE)
Arguments
expr

An expression

safe

A logical value, whether errors should be caught

Method eval_code()

Evaluate some code in the R session and return the result.

Usage
RSessionAdapter$eval_code(code, safe = FALSE)
Arguments
code

A character string of code

safe

A logical value, whether errors should be caught

Method ls()

Run 'ls()' in the R session and return the result.

Usage
RSessionAdapter$ls()

Method get()

Get the value of a variable (named object) from the R session and return it.

Usage
RSessionAdapter$get(n)
Arguments
n

The name of the variable

Method assign()

Assign a value to a variable in the R session

Usage
RSessionAdapter$assign(n, value)
Arguments
n

A variable name

value

The value that is assigned to the variable

Method setOption()

Set an option in the R session

Usage
RSessionAdapter$setOption(n, value)
Arguments
n

The name of the option

value

The intended option value

Method importOption()

Import an option value from the R session to the kernel

Usage
RSessionAdapter$importOption(n)
Arguments
n

The option value

Method handle_BEL()

Handle special output from the R session that starts with BEL

Usage
RSessionAdapter$handle_BEL(
  txt,
  input_callback,
  stdout_callback,
  stderr_callback
)
Arguments
txt

Output string containing BEL

input_callback

A function to request input from the frontend

stdout_callback

A function to process output obtained from the R session via "stdout" channel

stderr_callback

A function to process output obtained from the R session via "stderr" channel

Method handle_readline()

Handle special an input request obtained from the R session via output indicated with a special output string

Usage
RSessionAdapter$handle_readline(
  txt,
  input_callback,
  stdout_callback,
  stderr_callback
)
Arguments
txt

Output string containing a special readline prompt

input_callback

A function to request input from the frontend

stdout_callback

A function to process output obtained from the R session via "stdout" channel

stderr_callback

A function to process output obtained from the R session via "stderr" channel

Method handle_scan()

Handle input request created by the function 'scan' the in the R session

Usage
RSessionAdapter$handle_scan(
  txt,
  input_callback,
  stdout_callback,
  stderr_callback
)
Arguments
txt

Output string containing a special readline prompt

input_callback

A function to request input from the frontend

stdout_callback

A function to process output obtained from the R session via "stdout" channel

stderr_callback

A function to process output obtained from the R session via "stderr" channel

Method clone()

The objects of this class are cloneable with this method.

Usage
RSessionAdapter$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

The R Session Base Class

Description

An object of this class handles the lower-level communication with an R process. Objects of class RKernelSession inherit from this class.

Super classes

processx::process -> callr::r_session -> RSessionBase

Public fields

prompt

The command prompt

banner

The R startup message used as a session banner in the terminal and info box.

waiting

A logical value, whether the R session is waiting for input.

Methods

Public methods

Inherited methods

Method new()

Initialize the object and start the session

Usage
RSessionBase$new(
  options = r_session_options(stdout = "|", stderr = "|", cmdargs = c("--interactive",
    "--no-readline", "--no-save", "--no-restore"), env = c(R_CLI_NUM_COLORS =
    "16777216")),
  prompt = "> "
)
Arguments
options

R session objects, see r_session_options.

prompt

The expected prompt string of the R session

env

A character vector with environment variables for the R process

Method sleeping()

Returns a logical value, indicating whether the R process is sleeping.

Usage
RSessionBase$sleeping()

Method send_input()

Send input text to the R process

Usage
RSessionBase$send_input(text, drop_echo = FALSE)
Arguments
text

A character string

drop_echo

A logical value, whether to drop the echo from stdout.

Method read_output()

Read output from the R session and drop input echo if so requested

Usage
RSessionBase$read_output(n = -1)
Arguments
n

The number of characters to read

Method receive_output()

Poll R process for output and read it

Usage
RSessionBase$receive_output(timeout = 1)
Arguments
timeout

A number, the polling timeout in microseconds

Method receive_all_output()

Receive all output that is available

Usage
RSessionBase$receive_all_output(timeout = 1)
Arguments
timeout

A number, the polling timeout in microseconds

Method send_receive()

Send text to R process and receive all output from the process

Usage
RSessionBase$send_receive(text, timeout = 100)
Arguments
text

A character string

timeout

An integer number, the polling timeout

Method clone()

The objects of this class are cloneable with this method.

Usage
RSessionBase$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Tabs and Accordions

Description

Classes and constructor functions for tab and accordion widgets

Usage

Accordion(...)

Tab(...)

Stack(...)

Arguments

...

Arguments passed to the superclass constructor

Functions

  • Accordion(): The constructor function for accordion widgets.

  • Tab(): The construction function for accordion widgets.

  • Stack(): The construction function for accordion widgets.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::Box -> Box

Public fields

_titles

A dictionary of strings, for internal use only

titles

A dictionary of strings, exposed since ipywidgets 8.

selected_index

An integer, the field currently selected.

Methods

Public methods

Inherited methods

Method validate_index()

Validate the index, i.e. check whether it is within range.

Usage
SelectionContainerClass$validate_index(index)
Arguments
index

An integer number.

Method set_title()

Set the title of one of the elements.

Usage
SelectionContainerClass$set_title(index, title)
Arguments
index

The index number of the element to be changed.

title

A character string, the intended title.

Method get_title()

Get the title of one of the elements.

Usage
SelectionContainerClass$get_title(index)
Arguments
index

The index number of the element to be enquired.

Method new()

An initializer function

Usage
SelectionContainerClass$new(children = list(), ...)
Arguments
children

A list of widgets

...

Other arguments, passed to the superclass method

Method clone()

The objects of this class are cloneable with this method.

Usage
SelectionContainerClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::Box -> Accordion

Public fields

_model_name

Name of the Javascript model in the frontend.

_view_name

Name of the Javascript view in the frontend.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
AccordionClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::Box -> Tab

Public fields

_model_name

Name of the Javascript model in the frontend.

_view_name

Name of the Javascript view in the frontend.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
TabClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::Box -> Stack

Public fields

_model_name

Name of the Javascript model in the frontend.

_view_name

Name of the Javascript view in the frontend.

required_version

Minimum required ipywidgets version in which the current widget class is supported.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
StackClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Selection widgets

Description

Classes and constructors for selection widgets, i.e. dropdowns, listboxes etc.

Usage

SelectionWidget(options, value, ...)

Dropdown(options, value, ...)

RadioButtons(options, value, ...)

ListBox(options, value, ...)

ToggleButtons(options, value, ...)

SelectionSlider(options, value, ...)

MultipleSelectionWidget(options, value, ...)

ListBoxMultiple(options, value, ...)

SelectionRangeSlider(options, value, ...)

Arguments

options

A named vector or a vector coerceable into a character vector.
value

A trait.
...

Any other arguments, ignored.

Functions

  • SelectionWidget(): A constructor function for selection widgets.

  • Dropdown(): The construction function for dropdown widgets.

  • RadioButtons(): The construction function for radiobuttons widgets.

  • ListBox(): The construction function for listbox-selection widgets.

  • ToggleButtons(): The construction function for togglebuttons widgets.

  • SelectionSlider(): The construction function for listbox widgets with multiple selections.

  • MultipleSelectionWidget(): The construction function for multiple-selection widgets.

  • ListBoxMultiple(): The construction function for listbox widgets with multiple selections.

  • SelectionRangeSlider(): The construction function for listbox widgets with multiple selections.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> SelectionWidget

Public fields

_options_labels

A unicode vector of option labels.

index

An integer that refers to currently selected item.

Active bindings

value

The selected option

Methods

Public methods

Inherited methods

Method validate_index()

Validate an index argument.

Usage
SelectionWidgetClass$validate_index(index)
Arguments
index

The index to be checked.

Method new()

Initialiser

Usage
SelectionWidgetClass$new(options, value, ...)
Arguments
options

A named vector or a vector coerceable into a character vector.

value

Name of a selectable option.

...

Any other arguments, ignored.

Method clone()

The objects of this class are cloneable with this method.

Usage
SelectionWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::SelectionWidget -> Dropdown

Public fields

_model_name

Name of the Javascript model in the frontend.

_view_name

Name of the Javascript view in the frontend.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
DropdownClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::SelectionWidget -> RadioButtons

Public fields

_model_name

Name of the Javascript model in the frontend.

_view_name

Name of the Javascript view in the frontend.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
RadioButtonsClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::SelectionWidget -> ListboxSelect

Public fields

_model_name

Name of the Javascript model in the frontend.

_view_name

Name of the Javascript view in the frontend.

rows

An integer, the number of rows.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
ListboxSelectClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DescriptionStyle -> ToggleButtonsStyle

Public fields

_model_name

Name of the Javascript model in the frontend.

button_width

A unicode string, the width in CSS language

font_weight

A unicode string, the font weight in CSS language

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
ToggleButtonsStyleClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::SelectionWidget -> ToggleButtons

Public fields

_model_name

Name of the Javascript model in the frontend.

_view_name

Name of the Javascript view in the frontend.

tooltips

A unicode vector with tooltips.

icons

A unicode vector with icon specs.

style

A TobbleButtonStyle widget

button_style

A character string, one of "primary", "success", "info", "warning", "danger", or the empty string.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
ToggleButtonsClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::SelectionWidget -> SelectionSlider

Public fields

_model_name

Name of the Javascript model in the frontend.

_view_name

Name of the Javascript view in the frontend.

orientation

A Unicode string, either "horizontal" or "vertical"

readout

A logical value, whether the value should be showns (read out)

continuous_update

A logical value, whether values should be updated as the slider is moved by the user

style

A SliderStyle widget

behavior

A string that describes the ddragging behavior.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
SelectionSliderClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> MultipleSelectionWidget

Public fields

_options_labels

A unicode string vector with labels

index

An integer vector of indices of currenlty selected elements.

Active bindings

value

The selected option

Methods

Public methods

Inherited methods

Method validate_index()

Validate an index.

Usage
MultipleSelectionWidgetClass$validate_index(index)
Arguments
index

An index, the index to be checked.

Method new()

Initialiser

Usage
MultipleSelectionWidgetClass$new(options, value, ...)
Arguments
options

A named vector or a vector coerceable into a character vector.

value

Names of selectable options.

...

Any other arguments, ignored.

Method clone()

The objects of this class are cloneable with this method.

Usage
MultipleSelectionWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::MultipleSelectionWidget -> ListboxSelectMultiple

Public fields

_model_name

Name of the Javascript model in the frontend.

_view_name

Name of the Javascript view in the frontend.

rows

An integer, the number of rows.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
ListboxSelectMultipleClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::MultipleSelectionWidget -> SelectionRangeSlider

Public fields

_model_name

Name of the Javascript model in the frontend.

_view_name

Name of the Javascript view in the frontend.

orientation

A Unicode string, either "horizontal" or "vertical"

readout

A logical value, whether the value should be showns (read out)

continuous_update

A logical value, whether values should be updated as the slider is moved by the user

style

A SliderStyle widget

behavior

A string that describes the ddragging behavior.

Methods

Public methods

Inherited methods

Method validate_index()

Validate an index.

Usage
SelectionRangeSliderClass$validate_index(index)
Arguments
index

An index, the index to be checked.

Method new()

Initialiser

Usage
SelectionRangeSliderClass$new(options, value, ...)
Arguments
options

A named vector or a vector coerceable into a character vector.

value

Names of selectable options.

...

Any other arguments, ignored.

Method clone()

The objects of this class are cloneable with this method.

Usage
SelectionRangeSliderClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Set the port the HTTP server listens to. For internal use only.

Description

Set the port the HTTP server listens to. For internal use only.

Usage

set_http_port(port)

Arguments

port

An integer

R6 objects that run a help server

Description

An Object of class "sharedHelper" serves HTML help pages for one or several RKernel processes

Public fields

port

Integer, the port number

url

Character string, the base URL of the served help pages

orig_httpd

A function, set to the original HTTP server function

Methods

Public methods

Method new()

Intialize the object

Usage
sharedHelpServer$new(port = 0, prefix = "", use_proxy = FALSE)
Arguments
port

Integer, a port number

prefix

A character string, the URL prefix

use_proxy

A logical value, whether the help server is supposed to be run behind a jupyter proxy

Method httpd()

The function that serves paths and queries

Usage
sharedHelpServer$httpd(path, query, ...)
Arguments
path

A character string, the path part of an URL

query

An optional HTTP query string

...

Any other arguments, passed on to the original 'httpd' function.

Method run()

The server loop

Usage
sharedHelpServer$run()

Method publish_port()

Put a port number into a temporary file, for other processes to find

Usage
sharedHelpServer$publish_port(port)
Arguments
port

An integer, the port number

Method log()

Put log text into a temporary file, for other processes to read

Usage
sharedHelpServer$log(text)
Arguments
text

A character string to be added to the log file

Method clone()

The objects of this class are cloneable with this method.

Usage
sharedHelpServer$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Show the log of the HTTP requests.

Description

Show the log of the HTTP requests.

Usage

show_http_log()

Examples

show_http_log()

Sidecar widgets

Description

Sidecar widgets - works only with Jupyter Lab

Usage

Sidecar(...)

Arguments

...

Arguments passed to the inializer

Details

Note that these widget need the sidecar extension for Jupyter Lab. See https://github.com/jupyter-widgets/jupyterlab-sidecar

Functions

  • Sidecar(): A constructor for sidebar widgets

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::OutputWidget -> Sidecar

Public fields

_model_name

Name of the Javascript model in the frontend

_model_module

Name of the Javascript frontend module

_model_module_version

Version of the Javascript frontend module

_view_name

Name of the Javascript view in the frontend

_view_module

Name of the Javascript frontend view module

_view_module_version

Version of the the Javascript view module

title

A unicode string, the title of the widget.

anchor

A string that specifies where the widget s to appear: one of "split-right", "split-left", "split-top", "split-bottom", "tab-before", "tab-after", or "right".

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
SidecarClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Sliders

Description

Classes and constructor functions for sliders (integer and floating-point ones)

Usage

IntSlider(value = 0L, min = 0L, max = 100L, ...)

IntRangeSlider(value = c(0L, 50L), min = 0L, max = 100L, ...)

FloatSlider(value = 0, min = 0, max = 100, ...)

FloatRangeSlider(value = c(0, 50), min = 0, max = 100, ...)

FloatLogSlider(value = 1, min = 0, max = 40, base = 10, ...)

Arguments

value

A floating point number, the current value of the slider
min

A floating point number, the minimum value
max

A floating point number, the maximum value
...

Other arguments.
base

A floating point number, the base of the logarithm

Functions

  • IntSlider(): An integer slider constructor

  • IntRangeSlider(): An integer range slider constructor

  • FloatSlider(): A floating point slider constructor

  • FloatRangeSlider(): A floating point slider range constructor

  • FloatLogSlider(): A floating point log-slider constructor

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DescriptionStyle -> SliderStyle

Public fields

_model_name

Name of the Javascript frontend model

handle_color

Unicode string, the color of the slider handle

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
SliderStyleClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::BoundedIntWidget -> IntSlider

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

step

An Integer traitlet, the minimal step size per slider movement

orientation

A Unicode string, either "horizontal" or "vertical"

readout

A logical value, whether the value should be showns (read out)

readout_format

A unicode string, the format specification

continuous_update

A logical value, whether values should be updated as the slider is moved by the user

disabled

A logical value, whether the slider is disabled

style

A SliderStyle widget

behavior

A string that describes the ddragging behavior.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
IntSliderClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::BoundedIntRangeWidget -> IntRangeSlider

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

step

An Integer traitlet, the minimal step size per slider movement

orientation

A Unicode string, either "horizontal" or "vertical"

readout

A logical value, whether the value should be showns (read out)

readout_format

A logical value, whether values should be updated as the slider is moved by the user

continuous_update

A logical value, whether values should be updated as the slider is moved by the user

disabled

A logical value, whether the slider is disabled

style

A SliderStyle widget

behavior

A string that describes the ddragging behavior.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
IntRangeSliderClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::BoundedFloatWidget -> FloatSlider

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

step

A Float traitlet, the minimal step size per slider movement

orientation

A Unicode string, either "horizontal" or "vertical"

readout

A logical value, whether the value should be showns (read out)

readout_format

A logical value, whether values should be updated as the slider is moved by the user

continuous_update

A logical value, whether values should be updated as the slider is moved by the user

disabled

A logical value, whether the slider is disabled

style

A SliderStyle widget

behavior

A string that describes the ddragging behavior.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
FloatSliderClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::BoundedFloatRangeWidget -> FloatRangeSlider

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

step

A Float traitlet, the minimal step size per slider movement

orientation

A Unicode string, either "horizontal" or "vertical"

readout

A logical value, whether the value should be showns (read out)

readout_format

A logical value, whether values should be updated as the slider is moved by the user

continuous_update

A logical value, whether values should be updated as the slider is moved by the user

disabled

A logical value, whether the slider is disabled

style

A SliderStyle widget

behavior

A string that describes the ddragging behavior.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
FloatRangeSliderClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::BoundedLogFloatWidget -> FloatLogSlider

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

step

A Float traitlet, the minimal step size per slider movement

orientation

A Unicode string, either "horizontal" or "vertical"

readout

A logical value, whether the value should be showns (read out)

readout_format

A logical value, whether values should be updated as the slider is moved by the user

continuous_update

A logical value, whether values should be updated as the slider is moved by the user

disabled

A Boolean traitlet, whether the slider is disabled

base

A Float traitlet, the base of the logarithm

style

A SliderStyle widget

behavior

A string that describes the ddragging behavior.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
FloatLogSliderClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

importFrom svglite svgstring

Description

importFrom svglite svgstring

Usage

start_graphics()

Create an HTML iframe tag that refers to some (usually HTML) code

Description

Create an HTML iframe tag that refers to some (usually HTML) code

Usage

str2iframe(
  code,
  resize = FALSE,
  width = "100%",
  aspect_ratio = "16 / 10",
  height = character(0),
  class = "rkernel-iframe",
  style = "border-style:none",
  use_srcdoc = FALSE,
  ...
)

Arguments

code

The code to be shown in the iframe
resize

Logical; should the iframe be resizeable?
width

The intended width of the iframe, a string or a number
aspect_ratio

The intended aspect ratio of the iframe, a string
height

The intended height, a string. Overrides the aspect ratio if given.
class

The DOM class attribute the iframe, a string
style

The CSS style attribte of the iframe, a string
use_srcdoc

A logical value, whether the 'srcdoc' attribute should be used to set the iframe content, rather than the 'src' attribute.
...

Other arguments, ignored.

An Enumerated String Constructor

Description

An Enumerated String Constructor

Usage

StrEnum(...)

Arguments

...

Arguments passed to the trait instance initializer

An Enumerated Strings Trait

Description

An Enumerated Strings Trait

An Enumerated Strings Trait

Super classes

RKernel::Trait -> RKernel::Unicode -> StrEnum

Public fields

enum

a character vector

optional

A logical value, whether value can be empty.

Methods

Public methods

Inherited methods

Method validator()

Check whether the assigned vector is one of the allowed enumerated strings.

Usage
StrEnumClass$validator(value)
Arguments
value

A value to be assigned to the trait

Method new()

Initialize the trait.

Usage
StrEnumClass$new(enum, default = character(0), optional = FALSE)
Arguments
enum

A character vector of permitted enumerated strings.

default

The default value

optional

Logical can the value be empty?

Method clone()

The objects of this class are cloneable with this method.

Usage
StrEnumClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

String widgets

Description

Classes and constructor functions for string-related widgets (text areas etc.)

Usage

LabelStyle(...)

TextStyle(...)

HTMLStyle(...)

HTMLMathStyle(...)

StringWidget(value = character(0), ...)

HTML(value = character(0), ...)

HTMLMath(value = character(0), ...)

Label(value = character(0), ...)

Textarea(value = character(0), ...)

TextWidget(value = character(0), ...)

PasswordWidget(value = character(0), ...)

Combobox(value = character(0), ...)

Arguments

...

Arguments passed to the inializer
value

A character vector

Functions

  • LabelStyle(): The constructor for Label styles

  • TextStyle(): The constructor for Text styles

  • HTMLStyle(): The constructor for HTML styles

  • HTMLMathStyle(): The constructor for HTMLMath styles

  • StringWidget(): A constructor for string widgets

  • HTML(): A constructor for HTML widgets

  • HTMLMath(): A constructor for HTML widgets with math

  • Label(): A constructor for label widgets

  • Textarea(): A constructor for text area widgets

  • TextWidget(): A constructor for text field widgets

  • PasswordWidget(): A constructor for password entry widgets

  • Combobox(): A constructor for combo boxes

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DescriptionStyle -> StringStyle

Public fields

_model_name

Name of the Javascript model in the frontend

background

The background color

font_size

The font size

text_color

The text color

required_version

Minimum required ipywidgets version in which the current widget class is supported.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
StringStyleClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DescriptionStyle -> RKernel::StringStyle -> LabelStyle

Public fields

_model_name

Name of the Javascript model in the frontend

font_family

The font family

font_style

The font style

font_variant

The font variant

font_weight

The font weight

text_decoration

The text decoration

required_version

Minimum required ipywidgets version in which the current widget class is supported.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
LabelStyleClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DescriptionStyle -> RKernel::StringStyle -> TextStyle

Public fields

_model_name

Name of the Javascript model in the frontend

required_version

Minimum required ipywidgets version in which the current widget class is supported.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
TextStyleClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DescriptionStyle -> RKernel::StringStyle -> HTMLStyle

Public fields

_model_name

Name of the Javascript model in the frontend

required_version

Minimum required ipywidgets version in which the current widget class is supported.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
HTMLStyleClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DescriptionStyle -> RKernel::StringStyle -> HTMLMathStyle

Public fields

_model_name

Name of the Javascript model in the frontend

required_version

Minimum required ipywidgets version in which the current widget class is supported.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
HTMLMathStyleClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> StringWidget

Public fields

_model_name

Name of the Javascript model in the frontend

value

A unicode vector

placeholder

A placeholder character

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
StringWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::StringWidget -> HTML

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

style

The HTML style, an object of class "HTMLStyleClass"

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
HTMLClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::StringWidget -> HTMLMath

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

style

The HTMLMath style, an object of class "HTMLMathStyleClass"

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
HTMLMathClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::StringWidget -> Label

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

style

The Label style, an object of class "LabelStyleClass"

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
LabelClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::StringWidget -> Textarea

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

disabled

A logical value, whether the slider is disabled

continuous_update

A logical value, whether values should be updated as the slider is moved by the user

rows

An integer, the number of rows

style

The Text style, an object of class "TextStyleClass"

Methods

Public methods

Inherited methods

Method on_submit()

Add or remove a handler for submit events.

Usage
TextareaClass$on_submit(handler, remove = FALSE)
Arguments
handler

A function that is called when content is submitted by the user hitting 'enter'.

remove

Logical value, whether the handler is to be removed

Method clone()

The objects of this class are cloneable with this method.

Usage
TextareaClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::StringWidget -> TextWidget

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

disabled

A logical value, whether the slider is disabled

continuous_update

A logical value, whether values should be updated as the slider is moved by the user

style

The Text style, an object of class "TextStyleClass"

Methods

Public methods

Inherited methods

Method clear()

Clear the text area

Usage
TextWidgetClass$clear()

Method on_submit()

Add or remove a handler for submit events.

Usage
TextWidgetClass$on_submit(handler, remove = FALSE)
Arguments
handler

A function that is called when content is submitted by the user hitting 'enter'.

remove

Logical value, whether the handler is to be removed

Method clone()

The objects of this class are cloneable with this method.

Usage
TextWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::StringWidget -> RKernel::TextWidget -> PasswordWidget

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
PasswordWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::StringWidget -> RKernel::TextWidget -> Combobox

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

options

A unicode vector, the available options

ensure_option

A boolean (logical) value, whether at least one option has to be activated

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
ComboboxClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Tags Input Widgets

Description

Classes and constructors to great tag input widgets

Usage

TagsInput(...)

ColorsInput(...)

FloatsInput(...)

IntsInput(...)

Arguments

...

Arguments passed to the inializer

Functions

  • TagsInput(): A taginput constructor

  • ColorsInput(): A color taginput constructor

  • FloatsInput(): A color taginput constructor

  • IntsInput(): A color taginput constructor

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> TagsInputBase

Public fields

_model_name

Name of the Javascript model in the frontend

value

A list of tags

placeholder

A placeholder string

allowed_tags

Optional list with allowed tags.

allow_duplicates

Logical, whether duplicate tags are allowed.

required_version

Minimum required ipywidgets version in which the current widget class is supported.

Methods

Public methods

Inherited methods

Method validate_value()

Check value for validity,

Usage
TagsInputBaseClass$validate_value(value)
Arguments
value

A character string with one or more tags.

Method new()

Initializer function

Usage
TagsInputBaseClass$new(...)
Arguments
...

Arguments passed to the superclass initializer

Method clone()

The objects of this class are cloneable with this method.

Usage
TagsInputBaseClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::TagsInputBase -> TagsInput

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend.

value

A list of tags as unicode strings

tag_style

The string that describes the tag style

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
TagsInputClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::TagsInputBase -> ColorsInput

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend.

value

A list of tags as unicode strings

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
ColorsInputClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::TagsInputBase -> RKernel::TagsInput -> ColorsInput

Public fields

_model_name

Name of the Javascript model in the frontend

min

A Float traitlet, the minimum allowed value.

max

A Float traitlet, the maximum allowed value.

value

A list of numeric tags

Methods

Public methods

Inherited methods

Method validate_value()

Check value for validity,

Usage
NumbersInputBase$validate_value(value)
Arguments
value

A character string with one or more tags.

Method new()

Initializer function

Usage
NumbersInputBase$new(...)
Arguments
...

Arguments passed to the superclass initializer

value

An initial value

Method clone()

The objects of this class are cloneable with this method.

Usage
NumbersInputBase$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::TagsInputBase -> RKernel::TagsInput -> RKernel::ColorsInput -> FloatsInput

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend.

value

A list of numeric tags

format

The number format

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
FloatsInputClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> RKernel::TagsInputBase -> RKernel::TagsInput -> RKernel::ColorsInput -> IntsInput

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend.

min

A Integer traitlet, the minimum allowed value.

max

A Integer traitlet, the maximum allowed value.

value

A list of interger number tags

format

The number format

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
IntsInputClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Time Traitlets

Description

A class and constructor of time traitlets.

Super class

RKernel::Trait -> TimeClass

Public fields

value

A date.

coerce

Logical value, whether assignments to the value field should be coerced to the appropriate type.

Methods

Public methods

Inherited methods

Method validator()

Check the value assigned to the traitlet.

Usage
TimeClass$validator(value)
Arguments
value

The value assigned to the traitlet.

Method new()

Initialize the traitlet.

Usage
TimeClass$new(initial = as.POSIXct(integer(0)), coerce = TRUE)
Arguments
initial

An optional POSIXct object or an object coercive into such an object

coerce

An optional logical value

Method clone()

The objects of this class are cloneable with this method.

Usage
TimeClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Time Picker Widgets

Description

An R6 class and constructor function for time picker widgets

Usage

TimePicker(...)

Arguments

...

Arguments passed to the inializer

Functions

  • TimePicker(): A constructor for dat picker widgets

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> TimePicker

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

value

The date and time. If non-zero length, must have valid timezone info.

disabled

Boolean, whether the user can make changes

min

Minimum selectable date and time. If non-zero length, must have valid timezone info.

max

Maximum selectable date and time. If non-zero length, must have valid timezone info.

Methods

Public methods

Inherited methods

Method validate_value()

Check wether "value" is within range.

Usage
TimePickerClass$validate_value(value)
Arguments
value

A date and time to be checked for validity

Method validate_min()

Validate the "min" field after assignment.

Usage
TimePickerClass$validate_min(min)
Arguments
min

A minimum date and time to be checked for validity

Method validate_max()

Validate the "max" field after assignment.

Usage
TimePickerClass$validate_max(max)
Arguments
max

A maximum date and time to be checked for validity

Method new()

Usage
TimePickerClass$new(...)
Arguments
...

Arguments passed to the superclass initializer

Method clone()

The objects of this class are cloneable with this method.

Usage
TimePickerClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

A Genereric Converter to JSON

Description

The function to_json is a generic and idempotent interface to toJSON.

Usage

to_json(x, auto_unbox = TRUE, ...)

## Default S3 method:
to_json(x, auto_unbox = TRUE, ...)

## S3 method for class 'list'
to_json(x, auto_unbox = TRUE, ...)

## S3 method for class 'json'
to_json(x, ...)

## S3 method for class 'Trait'
to_json(x, auto_unbox = TRUE, ...)

## S3 method for class 'Vector'
to_json(x, ...)

## S3 method for class 'List'
to_json(x, auto_unbox = TRUE, ...)

## S3 method for class 'Widget'
to_json(x, ...)

## S3 method for class 'Bytes'
to_json(x, ...)

Arguments

x

An object to be converted as JSON
auto_unbox

A logical value, whether one-element a JSON list should be changed into JSON scalar.
...

Other arguments, passed on to toJSON.

Methods (by class)

  • to_json(default): Default S3 method

  • to_json(list): S3 method for lists.

  • to_json(json): S3 method for JSON character strings. Returns its argument as is, making to_json idempotent.

  • to_json(Trait): S3 method for 'TraitClass' objects, i.e. traitlets.

  • to_json(Vector): S3 method for 'VectorClass' objects

  • to_json(List): S3 method for 'ListClass' objects

  • to_json(Widget): S3 method for 'WidgetClass' objects, i.e. jupyter widgets

  • to_json(Bytes): S3 method for 'BytesClass' objects

Tobble-Button Widgets

Description

A constructor function and a class to create toggle-button widgets

Usage

ToggleButtonStyle(...)

ToggleButton(...)

Arguments

...

Arguments passed to the inializer

Functions

  • ToggleButtonStyle(): The constructor for Togglebuttons styles

  • ToggleButton(): A toggle-button constructor

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DescriptionStyle -> ToggleButtonStyle

Public fields

_model_name

Name of the Javascript model in the frontend

font_family

The font family

font_size

The font size

font_style

The font style

font_variant

The font variant

font_weight

The font weight

text_color

The text color

text_decoration

The text decoration

required_version

Minimum required ipywidgets version in which the current widget class is supported.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
ToggleButtonStyleClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> ToggleButton

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript model view in the frontend

value

Boolean, whether the box is checked

tooltip

A tooltip

description

A button description

disabled

Boolean, whether the button is disabled

icon

An icon (a fontawesome icon name)

button_style

The string that describes the button style

style

The toggle button style, an object of class "ToggleButtonStyleClass"

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
ToggleButtonClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Traitlets

Description

The class TraitClass brings (some of) the functionality of the traitlets framework on which the ipywidgets framework is based to R.

The function TraitInstance returns information needed by a HasTraits object to construct a TraitClass object.

Usage

Trait(...)

TraitInstance(Class, ...)

Arguments

...

Arguments passed to the inializer
Class

An R6 Class that inherits from "TraitClass"

Functions

  • Trait(): A Baseline Trait Constructor

  • TraitInstance(): A "Delayed Constructor" for Traits, to be used by constructors of derived classes.

Public fields

value

The value of the trait

observers

A list of functions to be called as notification callbacks

validators

A list of functions to check the validity of a

Methods

Public methods

Method set()

Set the value of the trait

Usage
TraitClass$set(value, notify = FALSE)
Arguments
value

The value to be set

notify

Logical; whether to call notification callbacks

Method get()

Get the trait value

Usage
TraitClass$get()

Method new()

Initialize the trait, i.e. set an initial value

Usage
TraitClass$new(initial)
Arguments
initial

The initial value

coerce

Logical; whether to coerce the initial value to the approriate mode.

Method clone()

The objects of this class are cloneable with this method.

Usage
TraitClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

A Unicode String Trait Constructor

Description

A Unicode String Trait Constructor

Usage

Unicode(...)

Arguments

...

Arguments passed to the trait instance initializer

A Unicode String Vector Trait

Description

A Unicode String Vector Trait

A Unicode String Vector Trait

Usage

## S3 method for class 'Unicode'
as.character(x, ...)

Arguments

x

A Unicode traitlet
...

Other arguments, ignored.

Functions

  • as.character(Unicode): Coerce a unicode string trait to a character vector

Super class

RKernel::Trait -> Unicode

Public fields

coerce

Logical value, whether values should be coerced to character strings.

length

Length of the unicode character vector

value

The value of the unicode character vector

optional

A logical value, whether value can be empty.

Methods

Public methods

Inherited methods

Method validator()

A validator function

Usage
UnicodeClass$validator(value)
Arguments
value

The value to be assigned

Method new()

Initialize an object

Usage
UnicodeClass$new(
  initial = character(0),
  coerce = TRUE,
  optional = length(initial) == 0,
  length = 1L
)
Arguments
initial

An initial value

coerce

Logical value, whether values should be coerced to character stringes

optional

Logical value, whether the value may be empty

length

Integer, the intended length of the unicode vector

Method clone()

The objects of this class are cloneable with this method.

Usage
UnicodeClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Get the prefix for internal URLs

Description

Get the prefix for internal URLs

Usage

url_prefix()

Create an HTML iframe tag that refers to some (usually HTML) code

Description

Create an HTML iframe tag that refers to some (usually HTML) code

Usage

url2iframe(
  url,
  resize = FALSE,
  width = "100%",
  aspect_ratio = "16 / 10",
  height = character(0),
  class = "rkernel-iframe",
  style = "border-style:none",
  ...
)

Arguments

url

The URL of the page to be shown in the iframe (can also be a data URI)
resize

Logical; should the iframe be resizeable?
width

The intended width of the iframe, a string or a number
aspect_ratio

The intended aspect ratio of the iframe, a string
height

The intended height, a string. Overrides the aspect ratio if given.
class

The DOM class attribute the iframe, a string
style

The CSS style attribte of the iframe, a string
...

Other arguments, ignored.

Validity Indicator Widgets

Description

A constructor function and a class to create toggle-button widgets

Usage

Valid(...)

Arguments

...

Arguments passed to the inializer

Functions

  • Valid(): A constructor for validity indicator widgets

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> RKernel::ValueWidget -> Valid

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript model view in the frontend

indent

Boolean, whether to indent the indicator widget

value

Boolean, whether the validity should be indicated

readout

Text to be shown if the Widget value is FALSE

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
ValidClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Value widgets

Description

A base class for widgets that are connected with values

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> RKernel::DescriptionWidget -> ValueWidget

Public fields

value

A list or any other vector of values

Methods

Public methods

Inherited methods

Method new()

A generic initializer function

Usage
ValueWidgetClass$new(value, ...)
Arguments
value

A value to initialize instance with

...

Any other arguments, ignored.

Method on_change()

Add handler function to be called when value is changed

Usage
ValueWidgetClass$on_change(handler, remove = FALSE)
Arguments
handler

A handler function

remove

A logical value, whether the handler should be removed or added.

Method clone()

The objects of this class are cloneable with this method.

Usage
ValueWidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Generic Vector Traitles

Description

A class and a constructor function to create generic vector trait(let)s.

Usage

Vector(...)

Arguments

...

Arguments that are passed to the initialize method of 'VectorClass'

Super class

RKernel::Trait -> Vector

Public fields

value

A list

class

A character string, the common class of the vector elements

Methods

Public methods

Inherited methods

Method validator()

A function that checks the validity of an assigned value, i.e. whether the assigned value is a list with all elements of the same class

Usage
VectorClass$validator(value)
Arguments
value

A value to be assigned as the traitlet value

Method new()

Usage
VectorClass$new(class = NULL, ...)
Arguments
class

String, optional common class

...

Arguments passed to the superclass initializer

Method clone()

The objects of this class are cloneable with this method.

Usage
VectorClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Invoke a Data Viewer

Description

This is a re-implementation of View that works within Jupyter notebooks by leveraging the Jupyter widgets infrastructure or by using the DataTables Javascript library. The latter is the case if the system option "View.backend" is set to "dataTable" or if this option is not set. Otherwise a 'virtable_widget' is used.

Usage

View(x, title = deparse(substitute(x)), ...)

## Default S3 method:
View(x, title = deparse(substitute(x)), ...)

## S3 method for class 'data.frame'
View(x, title = deparse(substitute(x)), ...)

## S3 method for class 'data.set'
View(x, title = deparse(substitute(x)), ...)

## S3 method for class 'importer'
View(x, title = deparse(substitute(x)), ...)

Arguments

x

An R object which can be coerced to a data frame with non-zero numbers of rows and columns.
title

A string used as title. Currently unused.
...

Other arguments, ignored.

Widgets to show tabular data

Description

This is a widget that can be used to potentially large tabular data objects, such as data frames. It is also a potential backend for the View function.

Usage

virtable_widget(
  x,
  pagesize = getOption("rkernel_view_size", c(10, 10)),
  continuous_update = TRUE
)

fmt_tab_section(x, i, j)

## Default S3 method:
fmt_tab_section(x, i, j)

## S3 method for class 'tbl_df'
fmt_tab_section(x, i, j)

Arguments

x

A tabular object, e.g. a data frame
pagesize

Number of rows and columns that are shown by the widget.
continuous_update

Logical, whether sliders should lead continuous updates.
i

Integer values, indexing rows
j

Integer values, indexing cols

Functions

  • fmt_tab_section(): Format a section of a tabular object to be used by virtable_widget.

  • fmt_tab_section(default): Default method

  • fmt_tab_section(tbl_df): Tibble method

Synchronize two Widgets Using a Link

Description

An R6 class and a constructor function for the creation of a link widget, which links two widgets so that their values are synchronized

Usage

WidgetLink(source, target, ...)

DirectionalLink(source, target, ...)

Arguments

source

A link with two elements, the first is a widget, the second is one of its traits.
target

A link with two elements, the first is a widget, the second is one of its traits.
...

Other arguments passed to the inializer

Details

The function WidgetLink creates objects of the R6 Class "WidgetLinkClass", which in turn have the S3 class attribute "WidgetLink"

Functions

  • WidgetLink(): The WidgetLink constructor function

  • DirectionalLink(): The WidgetLink constructor function

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::CoreWidget -> WidgetLink

Public fields

_model_name

Name of the Javascript model in the frontend.

source

A pair of Unicode strings, the first is the JSON representation of a widget, the second is the name of a trait(let) of the widget.

target

A pair of Unicode strings, the first is the JSON representation of a widget, the second is the name of a trait(let) of the widget.

Methods

Public methods

Inherited methods

Method new()

An initializer method

Usage
WidgetLinkClass$new(source, target, ...)
Arguments
source

A list with two elements, a widget and the name of a trait(let).

target

A list with two elements, a widget and the name of a trait(let).

...

Futher arguments, passed to the superclass initializer.

Method clone()

The objects of this class are cloneable with this method.

Usage
WidgetLinkClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::CoreWidget -> RKernel::WidgetLink -> DirectionalLink

Public fields

_model_name

Name of the Javascript model in the frontend.

Methods

Public methods

Inherited methods

Method clone()

The objects of this class are cloneable with this method.

Usage
DirectionalLinkClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

A Widget Base Class

Description

The base class from which all widget classes are derived

Usage

Widget(...)

Arguments

...

Arguments passed to the inializer

Functions

  • Widget(): A Widget Constructor Function

Super class

RKernel::HasTraits -> Widget

Public fields

_model_id

Identifyer of the frontend Javascript object

_model_name

Name of the Javascript model in the frontend

_model_module

Name of the Javascript module with the model

_model_module_version

Version of the module where the model is defined

_view_name

Name of the Javascript model view in the frontend

_view_module

Version of the module where the view is defined

_view_module_version

Version of the module where the view is defined

_view_count

Number of views that refer to the same frontend model object

traits_to_sync

Names of the traits to be synchronized with the frontend

sync_suspended

Logical value, whether synchronization is suspended

custom_msg_callbacks

A list of functions to be called on receiving a message

event_callbacks

A list of functions to be called on an event

displayed_callbacks

A list of functions to be called when the widget

_comm

The 'comm' connecting to the frontend or NULL

required_version

Minimum required ipywidgets version in which the current widget class is supported.

Active bindings

comm

The 'comm' connecting the frontend (as an active binding)

Methods

Public methods

Inherited methods

Method new()

Initialize an object

Usage
WidgetClass$new(..., open = TRUE)
Arguments
...

Values used for initialization

open

Logical, whether a connection with the frontend should be opened

Method open()

Open a connection to the frontend

Usage
WidgetClass$open()

Method close()

Close the connection to the frontend

Usage
WidgetClass$close()

Method get_state()

Prepare synchronized traits for sending them to the frontend

Usage
WidgetClass$get_state(keys = NULL)
Arguments
keys

Keys/names of the traits to be updated in the frontend

Method set_state()

Update the synchronized states, usually with information from the frontend

Usage
WidgetClass$set_state(state)
Arguments
state

A list of values for the synchronized traits

Method send_state()

Send updated traits to the frontend

Usage
WidgetClass$send_state(keys = NULL, drop_defaults = FALSE)
Arguments
keys

Keys/names of the traits to be updated in the frontend

drop_defaults

Logical value, not yet used

Method send()

Send content and binary buffers to the fronend

Usage
WidgetClass$send(content, buffers = NULL)
Arguments
content

Some user-defined information to be send to the frontend

buffers

Some raw vector buffers

Method display_data()

Send display-data of the widget to the frontend

Usage
WidgetClass$display_data()

Method handle_comm_opened()

Handle a 'comm' opened in the frontend

Usage
WidgetClass$handle_comm_opened(comm, data)
Arguments
comm

The 'comm' object that is opened

data

Data sent by the frontend

Method handle_comm_msg()

Handle a message from the frontend

Usage
WidgetClass$handle_comm_msg(comm, msg)
Arguments
comm

The 'comm' object via which the message is received

msg

Message sent by the frontend

Method handle_buffers()

Handle buffers in message. This method should be overwritten by inherting classes that actually process data in buffer components of messages.

Usage
WidgetClass$handle_buffers(msg)
Arguments
msg

A comm message

Method handle_custom_msg()

Call the custom message handlers

Usage
WidgetClass$handle_custom_msg(content)
Arguments
content

The data received

Method on_msg()

Install a handler for messages being received

Usage
WidgetClass$on_msg(handler, remove = FALSE)
Arguments
handler

A handler function

remove

Logical, should the handler be removed?

Method on_event()

Install a handler for events in the frontend

Usage
WidgetClass$on_event(event, handler, remove = FALSE)
Arguments
event

A character that describes the event

handler

A handler function

remove

Logical, should the handler be removed?

Method handle_event()

Call the installed event handlers

Usage
WidgetClass$handle_event(event, args)
Arguments
event

A string that describes the event

args

A list of argument passed on with the event

Method on_displayed()

Install a handler to be called when the widget is displayed

Usage
WidgetClass$on_displayed(handler, remove = FALSE)
Arguments
handler

A handler function

remove

Logical, should the handler be removed?

Method handle_displayed()

Call the installed display handlers

Usage
WidgetClass$handle_displayed()

Method _send()

The internal function to send messages to the frontend

Usage
WidgetClass$_send(msg, buffers = NULL)
Arguments
msg

The message

buffers

Raw data buffers or NULL

Method check_version()

Check whether current widget class is supported by ipywidgets

Usage
WidgetClass$check_version()

Method clone()

The objects of this class are cloneable with this method.

Usage
WidgetClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.