From 3b5a5d8e6f30797f1787e0c88b6dd2015f86c825 Mon Sep 17 00:00:00 2001 From: melff Date: Sat, 6 Jan 2024 16:57:37 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20melff/RK?= =?UTF-8?q?ernel@7ae7abb2ad3c5b7c513e1ec50e449f070759a86e=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 404.html | 106 ++- authors.html | 99 +- code-color-scheme-dark.css | 48 + code-color-scheme-light.css | 48 + darkswitch.js | 69 ++ index.html | 106 ++- pkgdown.js | 172 ++-- pkgdown.yml | 2 +- preferably.css | 37 + reference/Boolean.html | 109 ++- reference/BoundedFloatRangeWidget.html | 119 +-- reference/BoundedFloatText.html | 110 ++- reference/BoundedFloatWidget.html | 118 ++- reference/BoundedIntText.html | 110 ++- reference/BoundedIntWidget.html | 140 +-- reference/BoundedLogFloatWidget.html | 119 +-- reference/Boxes.html | 157 ++-- reference/BreakPoint.html | 88 +- reference/Buttons.html | 125 +-- reference/Bytes.html | 109 ++- reference/CSS.html | 92 +- reference/CallbackDispatcher.html | 107 ++- reference/Checkboxes.html | 123 +-- reference/ColorPicker.html | 109 ++- reference/ColorTrait.html | 108 ++- reference/Comm.html | 118 ++- reference/CommManager.html | 136 +-- reference/Context.html | 94 +- reference/CoreWidgetClass.html | 96 +- reference/DOMWidgetClass.html | 116 ++- reference/DateClass.html | 109 ++- reference/DatePicker.html | 117 ++- reference/DatetimeClass.html | 109 ++- reference/DatetimePicker.html | 139 +-- reference/Debugger.html | 96 +- reference/DescriptionStyle.html | 109 ++- reference/DescriptionWidget.html | 109 ++- reference/Dict.html | 104 ++- reference/Evaluator.html | 94 +- reference/EventManager.html | 116 ++- reference/FileUpload.html | 117 ++- reference/Fixed.html | 93 +- reference/Float.html | 109 ++- reference/FloatText.html | 110 ++- reference/FloatWidget.html | 110 ++- reference/Graphics.html | 93 +- reference/HasTraits.html | 94 +- reference/IFrame.html | 92 +- reference/IntText.html | 110 ++- reference/IntWidget.html | 110 ++- reference/Integer.html | 109 ++- reference/Javascript.html | 96 +- reference/Kernel.html | 94 +- reference/LaTeXMath.html | 92 +- reference/Layout.html | 119 +-- reference/LayoutTemplates.html | 155 ++-- reference/List.html | 107 ++- reference/MediaWidget.html | 163 ++-- reference/OutputWidget.html | 121 +-- reference/Page.html | 97 +- reference/Play.html | 110 ++- reference/PlotWidget.html | 107 ++- reference/Progress.html | 137 +-- reference/R6Class_.html | 92 +- reference/R6Instance.html | 91 +- reference/R6TraitClass.html | 97 +- reference/SelectionContainer.html | 159 ++-- reference/SelectionWidget.html | 257 +++--- reference/Sidecar.html | 109 ++- reference/Slider.html | 179 ++-- reference/StrEnum.html | 91 +- reference/StrEnumClass.html | 97 +- reference/StringWidget.html | 277 +++--- reference/TagsInput.html | 187 ++-- reference/TimeClass.html | 96 +- reference/TimePicker.html | 117 ++- reference/Togglebuttons.html | 123 +-- reference/Trace.html | 96 +- reference/Traitlets.html | 115 +-- reference/Unicode.html | 91 +- reference/UnicodeClass.html | 114 ++- reference/Valid.html | 109 ++- reference/ValueWidgetClass.html | 96 +- reference/Vector.html | 109 ++- reference/View.html | 94 +- reference/WidgetLink.html | 131 +-- reference/Widgets.html | 141 +-- reference/add_displayed_classes.html | 93 +- reference/add_paged_classes.html | 93 +- reference/alert.html | 92 +- reference/cell.options.html | 91 +- reference/dataTable.html | 116 ++- reference/dictionary.html | 102 ++- reference/display.html | 91 +- reference/display_data.html | 103 ++- reference/display_id.html | 100 +- reference/envBrowser.html | 91 +- reference/help.start.html | 92 +- reference/index.html | 1106 ++++++++++------------- reference/install.html | 95 +- reference/interaction.html | 91 +- reference/ls_str.html | 95 +- reference/main.html | 87 +- reference/mkWidget.html | 96 +- reference/raw_html.html | 92 +- reference/register_magic_handler.html | 92 +- reference/remove_displayed_classes.html | 93 +- reference/remove_paged_classes.html | 93 +- reference/services.html | 92 +- reference/sharedHelpServer.html | 93 +- reference/to_json.html | 96 +- reference/tracing_source.html | 92 +- reference/virtable_widget.html | 96 +- reference/with.Context.html | 92 +- 114 files changed, 7689 insertions(+), 5681 deletions(-) create mode 100644 code-color-scheme-dark.css create mode 100644 code-color-scheme-light.css create mode 100644 darkswitch.js create mode 100644 preferably.css diff --git a/404.html b/404.html index 2b805ef..d626153 100644 --- a/404.html +++ b/404.html @@ -4,76 +4,106 @@ - -Page not found (404) • RKernel - - - + + +Page not found (404) • RKernel + + - + + + + + + + - - Skip to contents + -
-
-
-

Page not found (404)

+ +
+ + + +
+
+
+

Page not found (404)

Content not found. Please use links in the navbar. -
+
+ + +
- + diff --git a/authors.html b/authors.html index a316429..e536800 100644 --- a/authors.html +++ b/authors.html @@ -1,79 +1,100 @@ -Authors and Citation • RKernelAuthors and Citation • RKernel - Skip to contents + -
-
-
-

Authors and Citation

-
+
+
+
+
+

Authors

+
-
-

Authors

  • Martin Elff. Author, maintainer.

+
+
+

Citation

+ +
+
-
-

Citation

-

-

Elff M (2024). +

Elff M (2024). RKernel: Yet another R kernel for Jupyter. R package version 0.6.

- 
@Manual{,
+    
@Manual{,
   title = {RKernel: Yet another R kernel for Jupyter},
   author = {Martin Elff},
   year = {2024},
   note = {R package version 0.6},
 }

-
-
+
- + diff --git a/code-color-scheme-dark.css b/code-color-scheme-dark.css new file mode 100644 index 0000000..3cec218 --- /dev/null +++ b/code-color-scheme-dark.css @@ -0,0 +1,48 @@ +pre { + word-wrap: normal; + word-break: normal; + /*border: 1px solid #eee;*/ + border: 0px !important; +} + +pre, code { + background-color: #1c1c1c; + color: #ccc; +} + +pre code { + overflow: auto; + word-wrap: normal; + white-space: pre; +} + +pre .img { + margin: 5px 0; +} + +pre .img img { + background-color: #aaa; + display: block; + height: auto; +} + +code a, pre a { + font-family: ui-monospace, SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace; + color: #85AACC; + text-decoration: underline; +} + +a.sourceLine:hover { + text-decoration: none; +} + +.fl {color: #ae81ff;} +.fu {color: #ade837;} /* function */ +.ch,.st {color: #e7db74;} /* string */ +.kw {color: #f92672;} /* keyword */ +.co {color: #696d70;} /* comment */ +.va {color: #fd971f;} /* values */ + +.message { color: black; font-weight: bolder;} +.error { color: orange; font-weight: bolder;} +.warning { color: #6A0366; font-weight: bolder;} diff --git a/code-color-scheme-light.css b/code-color-scheme-light.css new file mode 100644 index 0000000..6a23e80 --- /dev/null +++ b/code-color-scheme-light.css @@ -0,0 +1,48 @@ +pre { + word-wrap: normal; + word-break: normal; + /*border: 1px solid #eee;*/ + border: 0px !important; +} + +pre, code { + background-color: #f8f8f8; + color: #333; +} + +pre code { + overflow: auto; + word-wrap: normal; + white-space: pre; +} + +pre .img { + margin: 5px 0; +} + +pre .img img { + background-color: #fff; + display: block; + height: auto; +} + +code a, pre a { + font-family: ui-monospace, SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace; + color: #375f84; + text-decoration: underline; +} + +a.sourceLine:hover { + text-decoration: none; +} + +.fl {color: #1514b5;} +.fu {color: #8c60bf;} /* function */ +.ch,.st {color: #036a07;} /* string */ +.kw {color: #264D66;} /* keyword */ +.co {color: #888888;} /* comment */ +.va {color: #3032da;} /* values */ + +.message { color: black; font-weight: bolder;} +.error { color: orange; font-weight: bolder;} +.warning { color: #6A0366; font-weight: bolder;} \ No newline at end of file diff --git a/darkswitch.js b/darkswitch.js new file mode 100644 index 0000000..ad68ee0 --- /dev/null +++ b/darkswitch.js @@ -0,0 +1,69 @@ +$(document).ready(function(){ + + prefersDarkScheme = window.matchMedia("(prefers-color-scheme: dark)"); + + currentTheme = localStorage.getItem("theme"); + if (currentTheme) { + init_color_scheme_css("css", currentTheme); + init_color_scheme_css("css-code", currentTheme); + } else if (prefersDarkScheme) { + if (typeof $mode === 'undefined') { + $mode = 'light'; + if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) $mode = 'dark'; + init_color_scheme_css("css", $mode); + init_color_scheme_css("css-code", $mode); + } + toggle_color_scheme_css("css", $mode); + toggle_color_scheme_css("css-code", $mode); + } + + // function to initialise the css + function init_color_scheme_css($id, $mode) { + if ($("#"+$id)) $("#"+$id).remove(); // remove existing id + $("#"+$id+"-"+$mode).attr( { + "data-href-light": $("#"+$id+"-light").attr("href"), // store the light CSS url + "data-href-dark": $("#"+$id+"-dark").attr("href"), // store the dark CSS url + "data-color-scheme": $mode, // store the mode, so that we don't re-initalise + "media": "all", // drop the media filter + "id": $id // rename the id (drop the `-{mode}` bit) + } ); + $other = ($mode == 'dark') ? 'light' : 'dark'; + $("#"+$id+"-"+$other).remove(); + } + + // function to toggle the CSS + function toggle_color_scheme_css($id, $mode) { + // grab the new mode css href + $href = $("#"+$id).data("href-"+$mode); // use `.data()` here, leverage the cache + // set the CSS to the mode preference. + $("#"+$id).attr( { + "href": $href, + "data-color-scheme": $mode, + }); + } + + // toggle button click code + $("#css-toggle-btn").bind("click", function() { + // get current mode + // don't use `.data("color-scheme")`, it doesn't refresh + $mode = $("#css").attr("data-color-scheme"); + // test if this is a first time click event, if so initialise the code + if (typeof $mode === 'undefined') { + // not defined yet - set pref. & ask the browser if alt. is active + $mode = 'light'; + if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) $mode = 'dark'; + init_color_scheme_css("css", $mode); + init_color_scheme_css("css-code", $mode); + // `init_color_scheme_css()` any other CSS + } + // by here we have the current mode, so swap it + $new_mode = ($mode == 'dark') ? 'light' : 'dark'; + toggle_color_scheme_css("css", $new_mode); + toggle_color_scheme_css("css-code", $new_mode); + // `toggle_color_scheme_css()` any other CSS + + // Saving user's preference to the localStorage + localStorage.setItem("theme", $new_mode); + }); + +}); diff --git a/index.html b/index.html index 0b50dca..5ce99ca 100644 --- a/index.html +++ b/index.html @@ -4,53 +4,74 @@ - - -Yet another R kernel for Jupyter • RKernel - - - + + +Yet another R kernel for Jupyter • RKernel + + - + + + + + + + - - Skip to contents + -
-
-
+ +
+ + + + +
+
+

RKernel

This is a re-creation from scratch of an R kernel for Jupyter.

@@ -91,7 +112,10 @@ Make HTML widgets work more generally
-
+
- + diff --git a/pkgdown.js b/pkgdown.js index 5fccd9c..6f0eee4 100644 --- a/pkgdown.js +++ b/pkgdown.js @@ -2,30 +2,70 @@ (function($) { $(function() { - $('nav.navbar').headroom(); + $('.navbar-fixed-top').headroom(); - Toc.init({ - $nav: $("#toc"), - $scope: $("main h2, main h3, main h4, main h5, main h6") + $('body').css('padding-top', $('.navbar').height() + 10); + $(window).resize(function(){ + $('body').css('padding-top', $('.navbar').height() + 10); }); - if ($('#toc').length) { - $('body').scrollspy({ - target: '#toc', - offset: $("nav.navbar").outerHeight() + 1 - }); + $('[data-toggle="tooltip"]').tooltip(); + + var cur_path = paths(location.pathname); + var links = $("#navbar ul li a"); + var max_length = -1; + var pos = -1; + for (var i = 0; i < links.length; i++) { + if (links[i].getAttribute("href") === "#") + continue; + // Ignore external links + if (links[i].host !== location.host) + continue; + + var nav_path = paths(links[i].pathname); + + var length = prefix_length(nav_path, cur_path); + if (length > max_length) { + max_length = length; + pos = i; + } } - // Activate popovers - $('[data-bs-toggle="popover"]').popover({ - container: 'body', - html: true, - trigger: 'focus', - placement: "top", - sanitize: false, - }); + // Add class to parent
  • , and enclosing
  • if in dropdown + if (pos >= 0) { + var menu_anchor = $(links[pos]); + menu_anchor.parent().addClass("active"); + menu_anchor.closest("li.dropdown").addClass("active"); + } + }); + + function paths(pathname) { + var pieces = pathname.split("/"); + pieces.shift(); // always starts with / + + var end = pieces[pieces.length - 1]; + if (end === "index.html" || end === "") + pieces.pop(); + return(pieces); + } + + // Returns -1 if not found + function prefix_length(needle, haystack) { + if (needle.length > haystack.length) + return(-1); - $('[data-bs-toggle="tooltip"]').tooltip(); + // Special case for length-0 haystack, since for loop won't run + if (haystack.length === 0) { + return(needle.length === 0 ? 0 : -1); + } + + for (var i = 0; i < haystack.length; i++) { + if (needle[i] != haystack[i]) + return(i); + } + + return(haystack.length); + } /* Clipboard --------------------------*/ @@ -38,7 +78,7 @@ if(ClipboardJS.isSupported()) { $(document).ready(function() { - var copyButton = ""; + var copyButton = ""; $("div.sourceCode").addClass("hasCopyButton"); @@ -49,108 +89,20 @@ $('.btn-copy-ex').tooltip({container: 'body'}); // Initialize clipboard: - var clipboard = new ClipboardJS('[data-clipboard-copy]', { + var clipboardBtnCopies = new ClipboardJS('[data-clipboard-copy]', { text: function(trigger) { return trigger.parentNode.textContent.replace(/\n#>[^\n]*/g, ""); } }); - clipboard.on('success', function(e) { + clipboardBtnCopies.on('success', function(e) { changeTooltipMessage(e.trigger, 'Copied!'); e.clearSelection(); }); - clipboard.on('error', function() { + clipboardBtnCopies.on('error', function() { changeTooltipMessage(e.trigger,'Press Ctrl+C or Command+C to copy'); }); - }); } - - /* Search marking --------------------------*/ - var url = new URL(window.location.href); - var toMark = url.searchParams.get("q"); - var mark = new Mark("main#main"); - if (toMark) { - mark.mark(toMark, { - accuracy: { - value: "complementary", - limiters: [",", ".", ":", "/"], - } - }); - } - - /* Search --------------------------*/ - /* Adapted from https://github.com/rstudio/bookdown/blob/2d692ba4b61f1e466c92e78fd712b0ab08c11d31/inst/resources/bs4_book/bs4_book.js#L25 */ - // Initialise search index on focus - var fuse; - $("#search-input").focus(async function(e) { - if (fuse) { - return; - } - - $(e.target).addClass("loading"); - var response = await fetch($("#search-input").data("search-index")); - var data = await response.json(); - - var options = { - keys: ["what", "text", "code"], - ignoreLocation: true, - threshold: 0.1, - includeMatches: true, - includeScore: true, - }; - fuse = new Fuse(data, options); - - $(e.target).removeClass("loading"); - }); - - // Use algolia autocomplete - var options = { - autoselect: true, - debug: true, - hint: false, - minLength: 2, - }; - var q; -async function searchFuse(query, callback) { - await fuse; - - var items; - if (!fuse) { - items = []; - } else { - q = query; - var results = fuse.search(query, { limit: 20 }); - items = results - .filter((x) => x.score <= 0.75) - .map((x) => x.item); - if (items.length === 0) { - items = [{dir:"Sorry 😿",previous_headings:"",title:"No results found.",what:"No results found.",path:window.location.href}]; - } - } - callback(items); -} - $("#search-input").autocomplete(options, [ - { - name: "content", - source: searchFuse, - templates: { - suggestion: (s) => { - if (s.title == s.what) { - return `${s.dir} >
    ${s.title}
    `; - } else if (s.previous_headings == "") { - return `${s.dir} >
    ${s.title}
    > ${s.what}`; - } else { - return `${s.dir} >
    ${s.title}
    > ${s.previous_headings} > ${s.what}`; - } - }, - }, - }, - ]).on('autocomplete:selected', function(event, s) { - window.location.href = s.path + "?q=" + q + "#" + s.id; - }); - }); })(window.jQuery || window.$) - - diff --git a/pkgdown.yml b/pkgdown.yml index 8f4b579..35da96c 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 2.19.2 pkgdown: 2.0.7 pkgdown_sha: ~ articles: {} -last_built: 2024-01-06T16:01Z +last_built: 2024-01-06T16:57Z urls: reference: https://melff.github.io/RKernel/reference article: https://melff.github.io/RKernel/articles diff --git a/preferably.css b/preferably.css new file mode 100644 index 0000000..d6493f7 --- /dev/null +++ b/preferably.css @@ -0,0 +1,37 @@ +body, p, a { + font-family: -apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji; + font-weight: 500; +} + +h1 { + font-family: -apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji; + font-weight: 800 !important; +} + +h2, h3, h4, h5, h6 { + font-family: -apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji; + font-weight: bold; +} + +pre, code, pre.usage, code.sourceCode.r, .sourceCode, .examples, .downlit, .sourceCode, .r { + font-family: ui-monospace, SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace; + font-weight: 500; +} + +.github-love { + stroke: #ea4aaa; + fill: #ea4aaa; +} + + +.preferably { + margin-top: -2px; +} + +@media (prefers-color-scheme: dark) { + + .github-love { + stroke: #db61a2; + fill: #db61a2; + } +} diff --git a/reference/Boolean.html b/reference/Boolean.html index bda2f06..056ac02 100644 --- a/reference/Boolean.html +++ b/reference/Boolean.html @@ -1,62 +1,76 @@ -Boolean Traitlets — Boolean • RKernelBoolean Traitlets — Boolean • RKernel - Skip to contents + -
    -
    -
    -

    Boolean Traitlets

    - -
    Boolean.Rd
    +
    -
    +

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

    -
    -

    Usage

    + 
    Boolean(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

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

    -
    -

    Super class

    +
    +

    Super class

    RKernel::Trait -> Boolean

    -
    -

    Public fields

    +
    +

    Public fields

    value

    A logical vector, usually of length 1

    @@ -76,8 +90,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -95,7 +109,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    value

    A value to be checked for validity

    @@ -116,7 +130,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    initial

    A value with which the traitlet is initialized

    @@ -144,7 +158,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -156,22 +170,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/BoundedFloatRangeWidget.html b/reference/BoundedFloatRangeWidget.html index a4dbe49..8e00197 100644 --- a/reference/BoundedFloatRangeWidget.html +++ b/reference/BoundedFloatRangeWidget.html @@ -1,58 +1,70 @@ -Widgets for Floating Point Number Ranges — BoundedFloatRangeWidget • RKernelWidgets for Floating Point Number Ranges — BoundedFloatRangeWidget • RKernel - Skip to contents - - -
    -
    -
    -

    Widgets for Floating Point Number Ranges

    - -
    BoundedFloatRangeWidget.Rd
    +
    -
    +

    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

    +
    +

    Arguments

    value

    A pair of floating point values.

    @@ -69,18 +81,18 @@

    Arguments -

    Details

    +
    +

    Details

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

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    value

    A Float traitlet.

    @@ -95,8 +107,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -140,7 +152,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    value

    A value, should be numeric.

    @@ -156,7 +168,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    min

    A minimum value, should be numeric.

    @@ -172,7 +184,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    max

    A maximum value, should be numeric.

    @@ -189,7 +201,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    ...

    Arguments passed to the superclass initializer.

    @@ -205,7 +217,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -217,22 +229,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/BoundedFloatText.html b/reference/BoundedFloatText.html index a81201b..ccbaf6a 100644 --- a/reference/BoundedFloatText.html +++ b/reference/BoundedFloatText.html @@ -1,55 +1,68 @@ -Widgets for Text Elements with Floating Point Numbers Bounded within an Interval — BoundedFloatText • RKernelWidgets for Text Elements with Floating Point Numbers Bounded within an Interval — BoundedFloatText • RKernel - Skip to contents + -
    -
    -
    -

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

    - -
    BoundedFloatText.Rd
    +
    -
    +

    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

    +
    +

    Arguments

    value

    Initial value of the floating point number.

    @@ -71,17 +84,17 @@

    Arguments -

    Details

    +
    +

    Details

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

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend.

    @@ -106,8 +119,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -151,7 +164,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -163,22 +176,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/BoundedFloatWidget.html b/reference/BoundedFloatWidget.html index 9203399..808295e 100644 --- a/reference/BoundedFloatWidget.html +++ b/reference/BoundedFloatWidget.html @@ -1,55 +1,68 @@ -Widgets for Bounded Floating Point Numbers — BoundedFloatWidget • RKernelWidgets for Bounded Floating Point Numbers — BoundedFloatWidget • RKernel - Skip to contents + -
    -
    -
    -

    Widgets for Bounded Floating Point Numbers

    - -
    BoundedFloatWidget.Rd
    +
    -
    +

    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

    +
    +

    Arguments

    value

    The floating point value

    @@ -66,17 +79,17 @@

    Arguments -

    Details

    +
    +

    Details

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

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    value

    A Float traitlet.

    @@ -91,8 +104,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -136,7 +149,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    value

    A value, should be numeric.

    @@ -152,7 +165,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    min

    A minimum value, should be numeric.

    @@ -168,7 +181,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    max

    A maximum value, should be numeric.

    @@ -184,7 +197,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    value

    The floating point value.

    @@ -212,7 +225,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -224,22 +237,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/BoundedIntText.html b/reference/BoundedIntText.html index 9cd98ed..0981fec 100644 --- a/reference/BoundedIntText.html +++ b/reference/BoundedIntText.html @@ -1,55 +1,68 @@ -Widgets for Text Elements with Integer Numbers Bounded within an Interval — BoundedIntText • RKernelWidgets for Text Elements with Integer Numbers Bounded within an Interval — BoundedIntText • RKernel - Skip to contents + -
    -
    -
    -

    Widgets for Text Elements with Integer Numbers Bounded within an Interval

    - -
    BoundedIntText.Rd
    +
    -
    +

    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

    +
    +

    Arguments

    value

    Initial value of the integer number

    @@ -71,17 +84,17 @@

    Arguments -

    Details

    +
    +

    Details

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

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend.

    @@ -106,8 +119,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -151,7 +164,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -163,22 +176,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/BoundedIntWidget.html b/reference/BoundedIntWidget.html index 17a5ada..f10fabe 100644 --- a/reference/BoundedIntWidget.html +++ b/reference/BoundedIntWidget.html @@ -1,57 +1,70 @@ -Widgets for Bounded Integer Numbers — BoundedIntWidget • RKernelWidgets for Bounded Integer Numbers — BoundedIntWidget • RKernel - Skip to contents + -
    -
    -
    -

    Widgets for Bounded Integer Numbers

    - -
    BoundedIntWidget.Rd
    +
    -
    +

    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

    +
    +

    Arguments

    value

    A pair of integer values

    @@ -68,17 +81,17 @@

    Arguments -

    Details

    +
    +

    Details

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

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    value

    A Integer traitlet.

    @@ -93,8 +106,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -138,7 +151,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    value

    A value, should be an integer number.

    @@ -154,7 +167,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    min

    A minimum value, should be an integer number.

    @@ -170,7 +183,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    max

    A maximum value, should be an integer number.

    @@ -187,7 +200,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    ...

    Arguments passed to the superclass initializer

    @@ -203,7 +216,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -214,12 +227,12 @@

    Arguments -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    value

    A Integer traitlet.

    @@ -234,8 +247,8 @@

    Public fields

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -279,7 +292,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    value

    A value, should be an integer number.

    @@ -295,7 +308,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    min

    A minimum value, should be an integer number.

    @@ -311,7 +324,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    max

    A maximum value, should be an integer number.

    @@ -328,7 +341,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    ...

    Arguments passed to the superclass initializer.

    @@ -344,7 +357,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -356,22 +369,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/BoundedLogFloatWidget.html b/reference/BoundedLogFloatWidget.html index a6bcb6b..05a87d8 100644 --- a/reference/BoundedLogFloatWidget.html +++ b/reference/BoundedLogFloatWidget.html @@ -1,58 +1,70 @@ -Widgets for Bounded Floating Point Numbers on a logarithmic scale — BoundedLogFloatWidget • RKernelWidgets for Bounded Floating Point Numbers on a logarithmic scale — BoundedLogFloatWidget • RKernel - Skip to contents - - -
    -
    -
    -

    Widgets for Bounded Floating Point Numbers on a logarithmic scale

    - -
    BoundedLogFloatWidget.Rd
    +
    -
    +

    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

    +
    +

    Arguments

    value

    The floating point value.

    @@ -73,18 +85,18 @@

    Arguments -

    Details

    +
    +

    Details

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

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    value

    A Float traitlet.

    @@ -103,8 +115,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -148,7 +160,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    value

    A value, should be numeric.

    @@ -164,7 +176,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    min

    A minimum value, should be numeric.

    @@ -180,7 +192,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    max

    A maximum value, should be numeric.

    @@ -196,7 +208,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    value

    The floating point value.

    @@ -224,7 +236,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -236,22 +248,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/Boxes.html b/reference/Boxes.html index baaca82..c5d7454 100644 --- a/reference/Boxes.html +++ b/reference/Boxes.html @@ -1,47 +1,61 @@ -Box Containers — Boxes • RKernelBox Containers — Boxes • RKernel - Skip to contents + -
    -
    -
    -

    Box Containers

    - -
    Boxes.Rd
    +
    -
    +

    Classes and constructor functions to create box container widgets

    -
    -

    Usage

    + 
    Box(..., layout = NULL)
 
 HBox(..., layout = NULL, wrap = FALSE)
@@ -51,8 +65,8 @@ 
    Usage
 GridBox(..., layout = NULL)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Arguments passed to the superclass constructor

    @@ -61,27 +75,27 @@

    Arguments -

    Details

    +
    +

    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

    +
    +

    Functions

    • Box(): A baseline box constructor

    • HBox(): A horizontal box constructor

    • VBox(): A vertical box constructor

    • GridBox(): A grid box constructor

    -
    -

    Super classes

    + -
    -

    Public fields

    +
    +

    Public fields

    _model_module

    Name of the Javascript module with the model

    @@ -116,8 +130,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -158,7 +172,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    children

    A list of widgets

    @@ -186,7 +200,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -197,12 +211,12 @@

    Arguments -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend

    @@ -213,8 +227,8 @@

    Public fields

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -255,7 +269,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -266,12 +280,12 @@

    Arguments -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend

    @@ -282,8 +296,8 @@

    Public fields

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -324,7 +338,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -335,12 +349,12 @@

    Arguments -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend

    @@ -351,8 +365,8 @@

    Public fields

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -393,7 +407,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -405,22 +419,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/BreakPoint.html b/reference/BreakPoint.html index 21c01e2..1b70f10 100644 --- a/reference/BreakPoint.html +++ b/reference/BreakPoint.html @@ -1,72 +1,90 @@ -Breakpoints — BreakPoint • RKernelBreakpoints — BreakPoint • RKernel - Skip to contents - - -
    -
    -
    -

    Breakpoints

    - -
    BreakPoint.Rd
    +
    -
    +

    The function BreakPoint can be used to set a breakpoint in a function or a script. Instead of a terminal input and output, the thus created breakpoint can be interacted with using a Widget.

    -
    -

    Usage

    + 
    BreakPoint()
    -
    +
    + +
    -
    +

    Developed by Martin Elff.

    -
    +

    Site built with pkgdown 2.0.7.

    +

    Using preferably template.

    -
    +

    + diff --git a/reference/Buttons.html b/reference/Buttons.html index 3d8db9a..a176de2 100644 --- a/reference/Buttons.html +++ b/reference/Buttons.html @@ -1,70 +1,84 @@ -Buttons — Button • RKernelButtons — Button • RKernel - Skip to contents + -
    -
    -
    -

    Buttons

    - -
    Buttons.Rd
    +
    -
    +

    Classes and constructor functions for boxes and box styles

    -
    -

    Usage

    + 
    Button(...)
 
 ButtonStyle(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Arguments passed to the inializer

    -
    -

    Functions

    +
    +

    Functions

    • Button(): A button constructor

    • ButtonStyle(): A constructor for a button style

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_module

    Name of the Javascript module with the model

    @@ -115,8 +129,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -158,7 +172,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    handler

    A function that is called when the button is clicked

    @@ -186,7 +200,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -197,12 +211,12 @@

    Arguments -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend

    @@ -241,8 +255,8 @@

    Public fields

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -279,7 +293,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -291,22 +305,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/Bytes.html b/reference/Bytes.html index 8892e6f..83dbe21 100644 --- a/reference/Bytes.html +++ b/reference/Bytes.html @@ -1,62 +1,76 @@ -Raw Bytes Traitlets — Bytes • RKernelRaw Bytes Traitlets — Bytes • RKernel - Skip to contents + -
    -
    -
    -

    Raw Bytes Traitlets

    - -
    Bytes.Rd
    +
    -
    +

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

    -
    -

    Usage

    + 
    Bytes(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

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

    -
    -

    Super class

    +
    +

    Super class

    RKernel::Trait -> Bytes

    -
    -

    Public fields

    +
    +

    Public fields

    value

    A raw bytes vector

    @@ -72,8 +86,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -91,7 +105,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    value

    A value to be checked for validity

    @@ -107,7 +121,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    initial

    A value with which the traitlet is initialized

    @@ -131,7 +145,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -143,22 +157,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/CSS.html b/reference/CSS.html index 793f3c9..f74fcc3 100644 --- a/reference/CSS.html +++ b/reference/CSS.html @@ -1,55 +1,68 @@ -Send CSS code to the frontend — CSS • RKernelSend CSS code to the frontend — CSS • RKernel - Skip to contents + -
    -
    -
    -

    Send CSS code to the frontend

    - -
    CSS.Rd
    +
    -
    +

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

    -
    -

    Usage

    + 
    CSS(text, file)
    -
    -

    Arguments

    +
    +

    Arguments

    text

    A character string with CSS styling information

    @@ -59,22 +72,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/CallbackDispatcher.html b/reference/CallbackDispatcher.html index 387e40f..e020411 100644 --- a/reference/CallbackDispatcher.html +++ b/reference/CallbackDispatcher.html @@ -1,69 +1,81 @@ -A Dispatcher for Callbacks — CallbackDispatcher • RKernelA Dispatcher for Callbacks — CallbackDispatcher • RKernel - Skip to contents - - -
    -
    -
    -

    A Dispatcher for Callbacks

    - -
    CallbackDispatcher.Rd
    +
    -
    +

    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

    ...

    Arguments passed to the inializer

    -
    -

    Functions

    +
    +

    Functions

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

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -82,7 +94,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    handler

    A function

    @@ -127,7 +139,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    ...

    Aruments passed on to the handler functions

    @@ -143,7 +155,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -155,22 +167,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/Checkboxes.html b/reference/Checkboxes.html index 72038c5..aee21dd 100644 --- a/reference/Checkboxes.html +++ b/reference/Checkboxes.html @@ -1,70 +1,84 @@ -Checkbox Widgets — Checkboxes • RKernelCheckbox Widgets — Checkboxes • RKernel - Skip to contents + -
    -
    -
    -

    Checkbox Widgets

    - -
    Checkboxes.Rd
    +
    -
    +

    A class and a constructor function to create checkbox widgets

    -
    -

    Usage

    + 
    CheckboxStyle(...)
 
 Checkbox(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Arguments passed to the inializer

    -
    -

    Functions

    +
    +

    Functions

    • CheckboxStyle(): The constructor for checkbox widgets

    • Checkbox(): The constructor for checkbox styles

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend

    @@ -80,8 +94,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -118,7 +132,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -129,12 +143,12 @@

    Arguments -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend

    @@ -165,8 +179,8 @@

    Public fields

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -207,7 +221,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -219,22 +233,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/ColorPicker.html b/reference/ColorPicker.html index ad936d0..fd6c85b 100644 --- a/reference/ColorPicker.html +++ b/reference/ColorPicker.html @@ -1,67 +1,81 @@ -Color picker widgets — ColorPicker • RKernelColor picker widgets — ColorPicker • RKernel - Skip to contents + -
    -
    -
    -

    Color picker widgets

    - -
    ColorPicker.Rd
    +
    -
    +

    A class and constructor function to create color picker widgets

    -
    -

    Usage

    + 
    ColorPicker(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Arguments passed to the inializer

    -
    -

    Functions

    +
    +

    Functions

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

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend

    @@ -84,8 +98,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -126,7 +140,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -138,22 +152,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/ColorTrait.html b/reference/ColorTrait.html index 848aa92..e17dec3 100644 --- a/reference/ColorTrait.html +++ b/reference/ColorTrait.html @@ -1,73 +1,86 @@ -A Color String Trait — ColorTrait • RKernelA Color String Trait — ColorTrait • RKernel - Skip to contents + -
    -
    -
    -

    A Color String Trait

    - -
    ColorTrait.Rd
    +
    -
    +

    A Color String Trait

    A Color String Trait

    -
    -

    Usage

    + 
    Color(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Arguments passed to the trait instance initializer

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    optional

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

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -85,7 +98,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    value

    The value assigned to the traitlet.

    @@ -101,7 +114,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -113,22 +126,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/Comm.html b/reference/Comm.html index 8ac8e96..b7af945 100644 --- a/reference/Comm.html +++ b/reference/Comm.html @@ -1,71 +1,84 @@ -Comms - connections between the kernel and the frontend — Comm • RKernelComms - connections between the kernel and the frontend — Comm • RKernel - Skip to contents + -
    -
    -
    -

    Comms - connections between the kernel and the frontend

    - -
    Comm.Rd
    +
    -
    +

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

    -
    -

    Usage

    + 
    Comm(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Arguments passed to the inializer

    -
    -

    Details

    +
    +

    Details

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

    -
    -

    Functions

    +
    +

    Functions

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

    -
    -

    Public fields

    +
    +

    Public fields

    id

    A character string, the comm id

    @@ -84,8 +97,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -108,7 +121,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    target_name

    A string, the name of the target

    @@ -136,7 +149,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    data

    A named list

    @@ -160,7 +173,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    data

    A named list

    @@ -188,7 +201,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    data

    A named list

    @@ -212,7 +225,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -224,22 +237,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/CommManager.html b/reference/CommManager.html index b245750..c216245 100644 --- a/reference/CommManager.html +++ b/reference/CommManager.html @@ -1,79 +1,92 @@ -A Manager for Comms — CommManager • RKernelA Manager for Comms — CommManager • RKernel - Skip to contents + -
    -
    -
    -

    A Manager for Comms

    - -
    CommManager.Rd
    +
    -
    +

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

    -
    -

    Usage

    + 
    CommManager(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Arguments passed to the inializer

    -
    -

    Details

    +
    +

    Details

    See the documentation of Jupyter custom messages.

    -
    -

    Functions

    +
    +

    Functions

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

    -
    -

    Public fields

    +
    +

    Public fields

    comms

    A list of Comms.

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -101,7 +114,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    kernel

    Reference to the relevant kernel

    @@ -121,7 +134,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    target_name

    A string, the name of the target.

    @@ -141,7 +154,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    target_name

    A string, the name of the target

    @@ -157,7 +170,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    target_name

    A string, the name of the target

    @@ -173,7 +186,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    target_name

    A string, the name of the target

    @@ -189,7 +202,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    target_name

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

    @@ -205,7 +218,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    target_name

    A string, the name of the target

    @@ -221,7 +234,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    target_name

    A string, the name of the target

    @@ -245,7 +258,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    id

    A string, the comm id

    @@ -265,7 +278,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    id

    A string, the comm id

    @@ -285,7 +298,7 @@

    Usage
    -

    Arguments

    +

    Arguments

    id

    A string, the comm id

    @@ -319,7 +332,7 @@

    Usage
    -

    Arguments

    +

    Arguments

    id

    A string, the comm id

    @@ -356,7 +369,7 @@

    Usage
    -

    Arguments

    +

    Arguments

    id

    A string, the comm id

    @@ -392,7 +405,7 @@

    Usage
    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -404,22 +417,27 @@

    Arguments

    +
    + +

    -
    + diff --git a/reference/Context.html b/reference/Context.html index 007f419..1f9caa3 100644 --- a/reference/Context.html +++ b/reference/Context.html @@ -1,62 +1,75 @@ -Context Objects — Context • RKernelContext Objects — Context • RKernel - Skip to contents - - -
    -
    -
    -

    Context Objects

    - -
    Context.Rd
    +
    -
    +

    Objects of this class are used to capture textual and graphical output, e.g. to display them in Jupyter notebook cells or dedicated widgets.

    -
    -

    Public fields

    +
    +

    Public fields

    last.value

    Value of last evaluated expression.

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -463,22 +476,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/CoreWidgetClass.html b/reference/CoreWidgetClass.html index d380f8d..d42e41d 100644 --- a/reference/CoreWidgetClass.html +++ b/reference/CoreWidgetClass.html @@ -1,52 +1,67 @@ -Yet Another Widget Class — CoreWidgetClass • RKernelYet Another Widget Class — CoreWidgetClass • RKernel - Skip to contents + -
    -
    -
    -

    Yet Another Widget Class

    - -
    CoreWidgetClass.Rd
    +
    -
    +

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

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_module

    Name of the Javascript module with the model

    @@ -69,8 +84,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -119,22 +134,27 @@

    Arguments

    +
    + +

    -
    + diff --git a/reference/DOMWidgetClass.html b/reference/DOMWidgetClass.html index 2d3abcd..d72d349 100644 --- a/reference/DOMWidgetClass.html +++ b/reference/DOMWidgetClass.html @@ -1,70 +1,83 @@ -A Base Class for DOM Widgets — DOMWidgetClass • RKernelA Base Class for DOM Widgets — DOMWidgetClass • RKernel - Skip to contents + -
    -
    -
    -

    A Base Class for DOM Widgets

    - -
    DOMWidgetClass.Rd
    +
    -
    +

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

    -
    -

    Usage

    + 
    DOMWidget(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Arguments passed to the inializer

    -
    -

    Functions

    +
    +

    Functions

    • DOMWidget(): The DOM widget constructor function

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_module

    Name of the Javascript module with the model

    @@ -88,8 +101,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -129,7 +142,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    className

    Name of the class attribute

    @@ -145,7 +158,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    className

    Name of the class attribute

    @@ -161,7 +174,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    className

    Name of the class attribute

    @@ -177,7 +190,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -189,22 +202,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/DateClass.html b/reference/DateClass.html index f112449..bb78565 100644 --- a/reference/DateClass.html +++ b/reference/DateClass.html @@ -1,55 +1,69 @@ -Date Traitlets — DateClass • RKernelDate Traitlets — DateClass • RKernel - Skip to contents + -
    -
    -
    -

    Date Traitlets

    - -
    DateClass.Rd
    +
    -
    +

    A class and constructor of date traitlets.

    -
    -

    Usage

    + 
    Date(...)
 
 # S3 method for DateClass
 as.Date(x, ...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Other arguments.

    @@ -58,12 +72,12 @@

    Arguments -

    Super class

    +
    +

    Super class

    RKernel::Trait -> DateClass

    -
    -

    Public fields

    +
    +

    Public fields

    value

    A date.

    @@ -75,8 +89,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -94,7 +108,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    value

    The value assigned to the traitlet.

    @@ -116,7 +130,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    initial

    An optional Date object or date string

    @@ -148,7 +162,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -160,22 +174,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/DatePicker.html b/reference/DatePicker.html index db97f49..3f240bd 100644 --- a/reference/DatePicker.html +++ b/reference/DatePicker.html @@ -1,67 +1,81 @@ -Date Picker Widgets — DatePicker • RKernelDate Picker Widgets — DatePicker • RKernel - Skip to contents + -
    -
    -
    -

    Date Picker Widgets

    - -
    DatePicker.Rd
    +
    -
    +

    An R6 class and constructor function for date picker widgets

    -
    -

    Usage

    + 
    DatePicker(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Arguments passed to the inializer

    -
    -

    Functions

    +
    +

    Functions

    • DatePicker(): A constructor for dat picker widgets

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend

    @@ -92,8 +106,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -137,7 +151,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    value

    A value

    @@ -153,7 +167,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    min

    A minimum value, should be an integer number.

    @@ -169,7 +183,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    max

    A maximum value, should be an integer number.

    @@ -186,7 +200,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    ...

    Arguments passed to the superclass initializer

    @@ -202,7 +216,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -214,22 +228,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/DatetimeClass.html b/reference/DatetimeClass.html index e85ef46..b2c28cd 100644 --- a/reference/DatetimeClass.html +++ b/reference/DatetimeClass.html @@ -1,64 +1,78 @@ -Datetime Traitlets — DatetimeClass • RKernelDatetime Traitlets — DatetimeClass • RKernel - Skip to contents + -
    -
    -
    -

    Datetime Traitlets

    - -
    DatetimeClass.Rd
    +
    -
    +

    A class and constructor of datetime traitlets.

    -
    -

    Usage

    + 
    Datetime(...)
 
 Time(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

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

    -
    -

    Super class

    +
    +

    Super class

    RKernel::Trait -> DatetimeClass

    -
    -

    Public fields

    +
    +

    Public fields

    value

    A date.

    @@ -70,8 +84,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -89,7 +103,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    value

    The value assigned to the traitlet.

    @@ -105,7 +119,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    initial

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

    @@ -125,7 +139,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -137,22 +151,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/DatetimePicker.html b/reference/DatetimePicker.html index e8eeeb8..df48038 100644 --- a/reference/DatetimePicker.html +++ b/reference/DatetimePicker.html @@ -1,70 +1,84 @@ -Datetime Picker Widgets — DatetimePicker • RKernelDatetime Picker Widgets — DatetimePicker • RKernel - Skip to contents + -
    -
    -
    -

    Datetime Picker Widgets

    - -
    DatetimePicker.Rd
    +
    -
    +

    An R6 class and constructor function for datetime picker widgets

    -
    -

    Usage

    + 
    DatetimePicker(...)
 
 NaiveDatetimePicker(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Arguments passed to the inializer

    -
    -

    Functions

    +
    +

    Functions

    • DatetimePicker(): A constructor for dat picker widgets

    • NaiveDatetimePicker(): A constructor for dat picker widgets

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend

    @@ -91,8 +105,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -137,7 +151,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    value

    A value

    @@ -153,7 +167,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    value

    A date and time to be checked for validity

    @@ -169,7 +183,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    min

    A minimum date and time to be checked for validity

    @@ -185,7 +199,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    max

    A maximum date and time to be checked for validity

    @@ -202,7 +216,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    ...

    Arguments passed to the superclass initializer

    @@ -218,7 +232,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -229,12 +243,12 @@

    Arguments -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend

    @@ -253,8 +267,8 @@

    Public fields

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -299,7 +313,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    value

    A value

    @@ -315,7 +329,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    value

    A date and time to be checked for validity

    @@ -332,7 +346,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    ...

    Arguments passed to the superclass initializer

    @@ -348,7 +362,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -360,22 +374,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/Debugger.html b/reference/Debugger.html index a69c124..7f2b429 100644 --- a/reference/Debugger.html +++ b/reference/Debugger.html @@ -1,50 +1,63 @@ -Interactive Debugger — dump.frames • RKernelInteractive Debugger — dump.frames • RKernel - Skip to contents + -
    -
    -
    -

    Interactive Debugger

    - -
    Debugger.Rd
    +
    -
    +

    Provides a Jupyter notebook compatible variant of debugger

    -
    -

    Usage

    + 
    dump.frames(
   dumpto = "last.dump",
   to.file = FALSE,
@@ -56,8 +69,8 @@ 
    Usage
 Debugger(dump = last.dump)
    -
    -

    Arguments

    +
    +

    Arguments

    dumpto

    Character string; name of the object or file that contains the dumped frames

    @@ -83,29 +96,34 @@

    Arguments -

    Functions

    +
    +

    Functions

    • dump.frames(): An adaptation of the function with the same name from the 'utils' package

    -

    +
    + +
    -
    +

    Developed by Martin Elff.

    -
    +

    Site built with pkgdown 2.0.7.

    +

    Using preferably template.

    -
    +
    + diff --git a/reference/DescriptionStyle.html b/reference/DescriptionStyle.html index 924e5e3..daec041 100644 --- a/reference/DescriptionStyle.html +++ b/reference/DescriptionStyle.html @@ -1,67 +1,81 @@ -Styling of Decscription Widgets — DescriptionStyle • RKernelStyling of Decscription Widgets — DescriptionStyle • RKernel - Skip to contents + -
    -
    -
    -

    Styling of Decscription Widgets

    - -
    DescriptionStyle.Rd
    +
    -
    +

    Objects of this class contain the CSS styling of description widgets

    -
    -

    Usage

    + 
    DescriptionStyle(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Arguments passed to the inializer

    -
    -

    Functions

    +
    +

    Functions

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

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_module

    Name of the Javascript module with the model

    @@ -92,8 +106,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -130,7 +144,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -142,22 +156,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/DescriptionWidget.html b/reference/DescriptionWidget.html index d0bfb4e..6f6c5a9 100644 --- a/reference/DescriptionWidget.html +++ b/reference/DescriptionWidget.html @@ -1,67 +1,81 @@ -Decscription Widgets — DescriptionWidget • RKernelDecscription Widgets — DescriptionWidget • RKernel - Skip to contents + -
    -
    -
    -

    Decscription Widgets

    - -
    DescriptionWidget.Rd
    +
    -
    +

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

    -
    -

    Usage

    + 
    DescriptionWidget(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Arguments passed to the inializer

    -
    -

    Functions

    +
    +

    Functions

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

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_module

    Name of the Javascript module with the model

    @@ -104,8 +118,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -145,7 +159,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -157,22 +171,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/Dict.html b/reference/Dict.html index 36fcc4b..dcd0944 100644 --- a/reference/Dict.html +++ b/reference/Dict.html @@ -1,65 +1,78 @@ -Dictionary Traitlets — Dict • RKernelDictionary Traitlets — Dict • RKernel - Skip to contents + -
    -
    -
    -

    Dictionary Traitlets

    - -
    Dict.Rd
    +
    -
    +

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

    -
    -

    Usage

    + 
    Dict(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

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

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -78,7 +91,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    value

    A value to be assigned as the traitlet value

    @@ -94,7 +107,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -106,22 +119,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/Evaluator.html b/reference/Evaluator.html index bab7736..3999ab6 100644 --- a/reference/Evaluator.html +++ b/reference/Evaluator.html @@ -1,54 +1,67 @@ -The Evaluator Class — Evaluator • RKernelThe Evaluator Class — Evaluator • RKernel - Skip to contents - - -
    -
    -
    -

    The Evaluator Class

    - -
    Evaluator.Rd
    +
    -
    +

    An object of this class provides the context in which Jupyter notebook cells are run -- i.e. the expression within are evaluated. Usually there is only one of such objects needed.

    -
    -

    Public fields

    +
    +

    Public fields

    cell_no

    The number of the cell currently executed

    @@ -65,8 +78,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -623,22 +636,27 @@

    Arguments

    +
    + +

    -
    + diff --git a/reference/EventManager.html b/reference/EventManager.html index 1f46806..b7d436f 100644 --- a/reference/EventManager.html +++ b/reference/EventManager.html @@ -1,66 +1,79 @@ -A Manager for Comms — EventManager • RKernelA Manager for Comms — EventManager • RKernel - Skip to contents + -
    -
    -
    -

    A Manager for Comms

    - -
    EventManager.Rd
    +
    -
    +

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

    -
    -

    Usage

    + 
    EventManager(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Arguments passed to the inializer

    -
    -

    Functions

    +
    +

    Functions

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

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -82,7 +95,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    type

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

    @@ -98,7 +111,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    event

    A string, the name of an event

    @@ -118,7 +131,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    event

    A string, the name of an event

    @@ -142,7 +155,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    event

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

    @@ -163,7 +176,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    event

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

    @@ -184,7 +197,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    event

    A string, the name of an event

    @@ -209,7 +222,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    events

    A character vector with names of events

    @@ -225,7 +238,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -237,22 +250,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/FileUpload.html b/reference/FileUpload.html index 5e2c35d..d6611e6 100644 --- a/reference/FileUpload.html +++ b/reference/FileUpload.html @@ -1,67 +1,81 @@ -File Upload Widgets — FileUpload • RKernelFile Upload Widgets — FileUpload • RKernel - Skip to contents + -
    -
    -
    -

    File Upload Widgets

    - -
    FileUpload.Rd
    +
    -
    +

    Class and constructor for file upload widgets

    -
    -

    Usage

    + 
    FileUpload(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Any arguments used to initialize the fields of the object

    -
    -

    Functions

    +
    +

    Functions

    • FileUpload(): The FileUpload constructor function

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend.

    @@ -109,16 +123,16 @@

    Public fields -

    Active bindings

    +
    +

    Active bindings

    names

    of the uploaded files

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -159,7 +173,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    description

    The button description

    @@ -179,7 +193,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    msg

    A comm message

    @@ -195,7 +209,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -207,22 +221,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/Fixed.html b/reference/Fixed.html index fab552b..4557616 100644 --- a/reference/Fixed.html +++ b/reference/Fixed.html @@ -1,79 +1,96 @@ -Fixed Arguements in Interactive Widgets — Fixed • RKernelFixed Arguements in Interactive Widgets — Fixed • RKernel - Skip to contents - - -
    -
    -
    -

    Fixed Arguements in Interactive Widgets

    - -
    Fixed.Rd
    +
    -
    +

    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

    +
    +

    Arguments

    x

    An object.

    -
    +
    + +
    -
    +

    Developed by Martin Elff.

    -
    +

    Site built with pkgdown 2.0.7.

    +

    Using preferably template.

    -
    +
    + diff --git a/reference/Float.html b/reference/Float.html index a70ba19..11a7f0f 100644 --- a/reference/Float.html +++ b/reference/Float.html @@ -1,47 +1,61 @@ -Floating Point Number Traitlets — Float • RKernelFloating Point Number Traitlets — Float • RKernel - Skip to contents + -
    -
    -
    -

    Floating Point Number Traitlets

    - -
    Float.Rd
    +
    -
    +

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

    -
    -

    Usage

    + 
    Float(...)
 
 # S3 method for Float
@@ -51,8 +65,8 @@ 
    Usage
 as.numeric(x, ...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Other arguments.

    @@ -61,12 +75,12 @@

    Arguments -

    Super class

    +
    +

    Super class

    RKernel::Trait -> Float

    -
    -

    Public fields

    +
    +

    Public fields

    value

    A numeric vector.

    @@ -86,8 +100,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -105,7 +119,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    value

    The value assigned to the traitlet.

    @@ -126,7 +140,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    initial

    A numeric vector, the initial value for the traitlet.

    @@ -155,7 +169,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -167,22 +181,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/FloatText.html b/reference/FloatText.html index 98157aa..d735972 100644 --- a/reference/FloatText.html +++ b/reference/FloatText.html @@ -1,55 +1,68 @@ -Widgets for Text Elements with Floating Point Numbers — FloatText • RKernelWidgets for Text Elements with Floating Point Numbers — FloatText • RKernel - Skip to contents + -
    -
    -
    -

    Widgets for Text Elements with Floating Point Numbers

    - -
    FloatText.Rd
    +
    -
    +

    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

    +
    +

    Arguments

    value

    Initial value of the floating point number.

    @@ -63,17 +76,17 @@

    Arguments -

    Details

    +
    +

    Details

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

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend.

    @@ -98,8 +111,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -140,7 +153,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -152,22 +165,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/FloatWidget.html b/reference/FloatWidget.html index f40fd63..3ed39b8 100644 --- a/reference/FloatWidget.html +++ b/reference/FloatWidget.html @@ -1,55 +1,68 @@ -Widgets for Floating Point Numbers — FloatWidget • RKernelWidgets for Floating Point Numbers — FloatWidget • RKernel - Skip to contents + -
    -
    -
    -

    Widgets for Floating Point Numbers

    - -
    FloatWidget.Rd
    +
    -
    +

    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

    +
    +

    Arguments

    value

    The floating point value

    @@ -58,25 +71,25 @@

    Arguments -

    Details

    +
    +

    Details

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

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    value

    A Float traitlet

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -117,7 +130,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -129,22 +142,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/Graphics.html b/reference/Graphics.html index e7b112a..e8817d2 100644 --- a/reference/Graphics.html +++ b/reference/Graphics.html @@ -1,58 +1,70 @@ -Send a graphics file to the frontend — Graphics • RKernelSend a graphics file to the frontend — Graphics • RKernel - Skip to contents - - -
    -
    -
    -

    Send a graphics file to the frontend

    - -
    Graphics.Rd
    +
    -
    +

    Send embed the contents of an png, jpeg, pdf, or svg file in the frontend or add a link to it (sending raw data and urls soon to be added)

    -
    -

    Usage

    + 
    Graphics(jpeg, pdf, png, svg)
    -
    -

    Arguments

    +
    +

    Arguments

    jpeg

    The path to a jpeg file

    @@ -70,22 +82,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/HasTraits.html b/reference/HasTraits.html index df0b864..28b1e24 100644 --- a/reference/HasTraits.html +++ b/reference/HasTraits.html @@ -1,54 +1,67 @@ -The Base Class of Objects with Traits — HasTraits • RKernelThe Base Class of Objects with Traits — HasTraits • RKernel - Skip to contents - - -
    -
    -
    -

    The Base Class of Objects with Traits

    - -
    HasTraits.Rd
    +
    -
    +

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

    -
    -

    Public fields

    +
    +

    Public fields

    traits

    A list of traits

    @@ -64,8 +77,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -182,22 +195,27 @@

    Arguments

    +
    + +

    -
    + diff --git a/reference/IFrame.html b/reference/IFrame.html index e6cf3ce..89a8c00 100644 --- a/reference/IFrame.html +++ b/reference/IFrame.html @@ -1,55 +1,68 @@ -Include HTML content using in an iframe — IFrame • RKernelInclude HTML content using in an iframe — IFrame • RKernel - Skip to contents + -
    -
    -
    -

    Include HTML content using in an iframe

    - -
    IFrame.Rd
    +
    -
    +

    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

    +
    +

    Arguments

    url

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

    @@ -71,22 +84,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/IntText.html b/reference/IntText.html index 6af1701..0aa50e2 100644 --- a/reference/IntText.html +++ b/reference/IntText.html @@ -1,55 +1,68 @@ -Widgets for Text Elements with Integer Numbers — IntText • RKernelWidgets for Text Elements with Integer Numbers — IntText • RKernel - Skip to contents + -
    -
    -
    -

    Widgets for Text Elements with Integer Numbers

    - -
    IntText.Rd
    +
    -
    +

    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

    +
    +

    Arguments

    value

    Initial value of the integer number

    @@ -63,17 +76,17 @@

    Arguments -

    Details

    +
    +

    Details

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

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend.

    @@ -98,8 +111,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -140,7 +153,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -152,22 +165,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/IntWidget.html b/reference/IntWidget.html index 08f2adf..e7c2b9a 100644 --- a/reference/IntWidget.html +++ b/reference/IntWidget.html @@ -1,55 +1,68 @@ -Widgets for Integer Numbers — IntWidget • RKernelWidgets for Integer Numbers — IntWidget • RKernel - Skip to contents + -
    -
    -
    -

    Widgets for Integer Numbers

    - -
    IntWidget.Rd
    +
    -
    +

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

    -
    -

    Usage

    + 
    IntWidget(value, ...)
    -
    -

    Arguments

    +
    +

    Arguments

    value

    The integer value.

    @@ -58,25 +71,25 @@

    Arguments -

    Details

    +
    +

    Details

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

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    value

    A Integer traitlet.

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -117,7 +130,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -129,22 +142,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/Integer.html b/reference/Integer.html index fab52fc..c7a2899 100644 --- a/reference/Integer.html +++ b/reference/Integer.html @@ -1,47 +1,61 @@ -Integer Traitlets — Integer • RKernelInteger Traitlets — Integer • RKernel - Skip to contents + -
    -
    -
    -

    Integer Traitlets

    - -
    Integer.Rd
    +
    -
    +

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

    -
    -

    Usage

    + 
    Integer(...)
 
 # S3 method for Integer
@@ -54,8 +68,8 @@ 
    Usage
 to_json(x, ...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Other arguments.

    @@ -64,12 +78,12 @@

    Arguments -

    Super class

    +
    +

    Super class

    RKernel::Trait -> Integer

    -
    -

    Public fields

    +
    +

    Public fields

    value

    An integer vector.

    @@ -89,8 +103,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -108,7 +122,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    value

    The value assigned to the traitlet.

    @@ -129,7 +143,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    initial

    An integer vector, the initial value for the traitlet.

    @@ -158,7 +172,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -170,22 +184,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/Javascript.html b/reference/Javascript.html index c6ad334..9f2047d 100644 --- a/reference/Javascript.html +++ b/reference/Javascript.html @@ -1,55 +1,68 @@ -Send Javascript to the frontend — Javascript • RKernelSend Javascript to the frontend — Javascript • RKernel - Skip to contents + -
    -
    -
    -

    Send Javascript to the frontend

    - -
    Javascript.Rd
    +
    -
    +

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

    -
    -

    Usage

    + 
    Javascript(text, file, as_tag = FALSE)
    -
    -

    Arguments

    +
    +

    Arguments

    text

    A character string with Javascript code

    @@ -62,29 +75,34 @@

    Arguments -

    Value

    +
    +

    Value

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

    -

    +
    + +
    -
    +

    Developed by Martin Elff.

    -
    +

    Site built with pkgdown 2.0.7.

    +

    Using preferably template.

    -
    +
    + diff --git a/reference/Kernel.html b/reference/Kernel.html index 02799d8..84863e6 100644 --- a/reference/Kernel.html +++ b/reference/Kernel.html @@ -1,54 +1,67 @@ -The Kernel Class — Kernel • RKernelThe Kernel Class — Kernel • RKernel - Skip to contents - - -
    -
    -
    -

    The Kernel Class

    - -
    Kernel.Rd
    +
    -
    +

    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

    +
    +

    Public fields

    evaluator

    See Evaluator.

    @@ -79,8 +92,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -565,22 +578,27 @@

    Arguments

    +
    + +

    -
    + diff --git a/reference/LaTeXMath.html b/reference/LaTeXMath.html index 4c280ac..bca9b2f 100644 --- a/reference/LaTeXMath.html +++ b/reference/LaTeXMath.html @@ -1,76 +1,94 @@ -Send LaTeX math to the frontend — LaTeXMath • RKernelSend LaTeX math to the frontend — LaTeXMath • RKernel - Skip to contents + -
    -
    -
    -

    Send LaTeX math to the frontend

    - -
    LaTeXMath.Rd
    +
    -
    +

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

    -
    -

    Usage

    + 
    LaTeXMath(text)
    -
    -

    Arguments

    +
    +

    Arguments

    text

    A character string with LaTeX code for math

    -
    +
    + +
    -
    +

    Developed by Martin Elff.

    -
    +

    Site built with pkgdown 2.0.7.

    +

    Using preferably template.

    -
    +
    + diff --git a/reference/Layout.html b/reference/Layout.html index 688dfb6..28edfd6 100644 --- a/reference/Layout.html +++ b/reference/Layout.html @@ -1,78 +1,90 @@ -Widget Layout Manipulation — Layout • RKernelWidget Layout Manipulation — Layout • RKernel - Skip to contents - - -
    -
    -
    -

    Widget Layout Manipulation

    - -
    Layout.Rd
    +
    -
    +

    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

    ...

    Arguments passed to the inializer

    -
    -

    Details

    +
    +

    Details

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

    -
    -

    Functions

    +
    +

    Functions

    • Layout(): The Layout constructor function

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _view_name

    Name of the Javascript view in the frontend.

    @@ -267,8 +279,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -306,7 +318,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    nm

    Name of the trait (a dummy argument)

    @@ -330,7 +342,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    ...

    Arguments passed to the superclass initializer

    @@ -346,7 +358,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -358,22 +370,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/LayoutTemplates.html b/reference/LayoutTemplates.html index 6a540e7..bf253b7 100644 --- a/reference/LayoutTemplates.html +++ b/reference/LayoutTemplates.html @@ -1,47 +1,61 @@ -Widget Layout Templates — LayoutTemplates • RKernelWidget Layout Templates — LayoutTemplates • RKernel - Skip to contents + -
    -
    -
    -

    Widget Layout Templates

    - -
    LayoutTemplates.Rd
    +
    -
    +

    R6 classes and constructor functions for widget layout templates

    -
    -

    Usage

    + 
    AppLayout(...)
 
 GridspecLayout(...)
@@ -55,8 +69,8 @@ 
    Usage
 TwoByTwoLayout(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Arguments used to initialize the fields

    @@ -81,12 +95,12 @@

    Arguments -

    Super classes

    + -
    -

    Public fields

    +
    +

    Public fields

    grid_gap

    The grid-gap CSS attribute

    @@ -109,8 +123,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -151,7 +165,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    ...

    Arguments used to initialize the fields

    @@ -167,7 +181,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -178,12 +192,12 @@

    Arguments -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    header

    Widget that appears in the header section

    @@ -218,8 +232,8 @@

    Public fields

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -260,7 +274,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    ...

    Arguments, passed on to the superclass initializer

    @@ -276,7 +290,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -287,12 +301,12 @@

    Arguments -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -335,7 +349,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    nrow

    A positive integer, the number of rows

    @@ -359,7 +373,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    i

    The rows into which the widget is to be placed

    @@ -383,7 +397,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    i

    The rows where the widget is located

    @@ -403,7 +417,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -414,12 +428,12 @@

    Arguments -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    top_left

    Widget that appears on the top left

    @@ -442,8 +456,8 @@

    Public fields

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -484,7 +498,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    ...

    Arguments, passed on to the superclass initializer

    @@ -500,7 +514,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -512,22 +526,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/List.html b/reference/List.html index 83e0864..5e33d1e 100644 --- a/reference/List.html +++ b/reference/List.html @@ -1,70 +1,84 @@ -List Traitlets — List • RKernelList Traitlets — List • RKernel - Skip to contents + -
    -
    -
    -

    List Traitlets

    - -
    List.Rd
    +
    -
    +

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

    -
    -

    Usage

    + 
    List(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

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

    -
    -

    Super class

    +
    +

    Super class

    RKernel::Trait -> List

    -
    -

    Public fields

    +
    +

    Public fields

    value

    A list

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -83,7 +97,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    value

    A value to be assigned as the traitlet value

    @@ -99,7 +113,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -111,22 +125,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/MediaWidget.html b/reference/MediaWidget.html index f8151f1..bbbdda0 100644 --- a/reference/MediaWidget.html +++ b/reference/MediaWidget.html @@ -1,47 +1,61 @@ -Media widgets — MediaWidget • RKernelMedia widgets — MediaWidget • RKernel - Skip to contents + -
    -
    -
    -

    Media widgets

    - -
    MediaWidget.Rd
    +
    -
    +

    Classes and constructors to wrap media into widgets

    -
    -

    Usage

    + 
    ImageWidget(...)
 
 VideoWidget(...)
@@ -49,25 +63,25 @@ 
    Usage
 AudioWidget(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Any arguments used to initialize the fields of the object

    -
    -

    Functions

    +
    +

    Functions

    • ImageWidget(): The ImageWidget constructor function

    • VideoWidget(): The VideoWidget constructor function

    • AudioWidget(): The AudioWidget constructor function

    -
    -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    format

    A string, giving the graphics fromat.

    @@ -78,8 +92,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -122,7 +136,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    url

    A character string

    @@ -146,7 +160,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    filename

    A character string

    @@ -163,7 +177,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    handler

    A function that is called when the button is clicked.

    @@ -183,7 +197,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    from_file

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

    @@ -207,7 +221,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -218,12 +232,12 @@

    Arguments -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _view_name

    Name of the Javascript view in the frontend.

    @@ -246,8 +260,8 @@

    Public fields

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -290,7 +304,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    filename

    A character string

    @@ -314,7 +328,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -325,12 +339,12 @@

    Arguments -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _view_name

    Name of the Javascript view in the frontend.

    @@ -365,8 +379,8 @@

    Public fields

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -409,7 +423,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    filename

    A character string

    @@ -433,7 +447,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -444,12 +458,12 @@

    Arguments -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _view_name

    Name of the Javascript view in the frontend.

    @@ -476,8 +490,8 @@

    Public fields

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -520,7 +534,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -532,22 +546,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/OutputWidget.html b/reference/OutputWidget.html index 0bbc079..7966353 100644 --- a/reference/OutputWidget.html +++ b/reference/OutputWidget.html @@ -1,55 +1,69 @@ -Widgets to receive output — OutputWidget • RKernelWidgets to receive output — OutputWidget • RKernel - Skip to contents + -
    -
    -
    -

    Widgets to receive output

    - -
    OutputWidget.Rd
    +
    -
    +

    Classes and constructors to wrap output created by code

    -
    -

    Usage

    + 
    OutputWidget(append_output = FALSE, ...)
 
 # S3 method for OutputWidget
 with(data, expr, envir = list(), enclos = parent.frame(), ...)
    -
    -

    Arguments

    +
    +

    Arguments

    append_output

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

    @@ -76,12 +90,12 @@

    Arguments -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _view_name

    Name of the Javascript model view in the frontend

    @@ -121,8 +135,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -174,7 +188,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    append_output

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

    @@ -203,7 +217,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    ...

    A single expression or several expressions included in curly braces.

    @@ -220,7 +234,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    expr

    The expression to be evaluated

    @@ -241,7 +255,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    expressions

    A list of expressions.

    @@ -262,7 +276,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    ...

    Further arguments, passed on to the 'evaluate' method of the Context class,

    @@ -279,7 +293,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    ...

    One or more character arguments

    @@ -299,7 +313,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    x

    Any argument to be 'print'ed

    @@ -319,7 +333,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    wait

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

    @@ -336,7 +350,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -348,22 +362,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/Page.html b/reference/Page.html index cae3b75..22a94a4 100644 --- a/reference/Page.html +++ b/reference/Page.html @@ -1,61 +1,73 @@ -Display an object using the Jupyter notebook pager — Page • RKernelDisplay an object using the Jupyter notebook pager — Page • RKernel - Skip to contents - - -
    -
    -
    -

    Display an object using the Jupyter notebook pager

    - -
    Page.Rd
    +
    -
    +

    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, ...)
 
 # S3 method for default
 Page(x, start = 1, ...)
    -
    -

    Arguments

    +
    +

    Arguments

    x

    An object to be displayed in the Notebook pager

    @@ -68,28 +80,33 @@

    Arguments -

    Methods (by class)

    +
    +

    Methods (by class)

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

    -

    +
    + +
    -
    +

    Developed by Martin Elff.

    -
    +

    Site built with pkgdown 2.0.7.

    +

    Using preferably template.

    -
    +
    + diff --git a/reference/Play.html b/reference/Play.html index cfc17f1..0fe848f 100644 --- a/reference/Play.html +++ b/reference/Play.html @@ -1,50 +1,63 @@ -A Player Widget — Play • RKernelA Player Widget — Play • RKernel - Skip to contents + -
    -
    -
    -

    A Player Widget

    - -
    Play.Rd
    +
    -
    +

    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,
@@ -56,8 +69,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    value

    Integer, an initial value.

    @@ -86,17 +99,17 @@

    Arguments -

    Functions

    +
    +

    Functions

    • Play(): The player widget constructor function.

    -
    -

    Super classes

    + -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend

    @@ -141,8 +154,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -186,7 +199,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -198,22 +211,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/PlotWidget.html b/reference/PlotWidget.html index d1a8191..d560b9c 100644 --- a/reference/PlotWidget.html +++ b/reference/PlotWidget.html @@ -1,47 +1,61 @@ -Widgets to receive plots graphics — PlotWidget • RKernelWidgets to receive plots graphics — PlotWidget • RKernel - Skip to contents + -
    -
    -
    -

    Widgets to receive plots graphics

    - -
    PlotWidget.Rd
    +
    -
    +

    Class and constructors show graphics created by code

    -
    -

    Usage

    + 
    SVGWidget(...)
 
 # S3 method for SVGWidget
@@ -50,8 +64,8 @@ 
    Usage
 PlotWidget(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Arguments, passed to the ImageWidget constructors.

    @@ -69,20 +83,20 @@

    Arguments -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    context

    A Context instance or NULL

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -123,7 +137,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    ...

    Arguments passed to the superclass initializer

    @@ -151,7 +165,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -163,22 +177,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/Progress.html b/reference/Progress.html index f470e7b..582b67c 100644 --- a/reference/Progress.html +++ b/reference/Progress.html @@ -1,47 +1,61 @@ -Progress bars — Progress • RKernelProgress bars — Progress • RKernel - Skip to contents + -
    -
    -
    -

    Progress bars

    - -
    Progress.Rd
    +
    -
    +

    Classes and constructor functions for progress bars and styling of them

    -
    -

    Usage

    + 
    ProgressStyle(...)
 
 IntProgress(value = 0L, min = 0L, max = 100L, ...)
@@ -49,8 +63,8 @@ 
    Usage
 FloatProgress(value = 0L, min = 0L, max = 100L, ...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Other arguments.

    @@ -67,19 +81,19 @@

    Arguments -

    Functions

    +
    +

    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

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend

    @@ -90,8 +104,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -128,7 +142,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -139,12 +153,12 @@

    Arguments -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend

    @@ -167,8 +181,8 @@

    Public fields

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -212,7 +226,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -223,12 +237,12 @@

    Arguments -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend

    @@ -251,8 +265,8 @@

    Public fields

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -296,7 +310,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -308,22 +322,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/R6Class_.html b/reference/R6Class_.html index 6bf47c3..081f4da 100644 --- a/reference/R6Class_.html +++ b/reference/R6Class_.html @@ -1,55 +1,68 @@ -R6 Objects That Are Not Locked — R6Class_ • RKernelR6 Objects That Are Not Locked — R6Class_ • RKernel - Skip to contents + -
    -
    -
    -

    R6 Objects That Are Not Locked

    - -
    R6Class_.Rd
    +
    -
    +

    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

    ...

    Arguments passed to the superclass constructor

    @@ -60,22 +73,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/R6Instance.html b/reference/R6Instance.html index db7a648..af0da2e 100644 --- a/reference/R6Instance.html +++ b/reference/R6Instance.html @@ -1,73 +1,92 @@ -A Generic Constructor for R6 Object Traits — R6Instance • RKernelA Generic Constructor for R6 Object Traits — R6Instance • RKernel - Skip to contents + -
    -
    -
    -

    A Generic Constructor for R6 Object Traits

    - -
    R6Instance.Rd
    +
    -
    +

    A Generic Constructor for R6 Object Traits

    -
    -

    Usage

    + 
    R6Instance(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Arguments passed to the trait instance initializer

    -
    +
    + +
    -
    +

    Developed by Martin Elff.

    -
    +

    Site built with pkgdown 2.0.7.

    +

    Using preferably template.

    -
    +
    + diff --git a/reference/R6TraitClass.html b/reference/R6TraitClass.html index 6e30a5d..343591a 100644 --- a/reference/R6TraitClass.html +++ b/reference/R6TraitClass.html @@ -1,55 +1,69 @@ -A Base Class for Traits that are R6 Objects — R6TraitClass • RKernelA Base Class for Traits that are R6 Objects — R6TraitClass • RKernel - Skip to contents + -
    -
    -
    -

    A Base Class for Traits that are R6 Objects

    - -
    R6TraitClass.Rd
    +
    -
    +

    A Base Class for Traits that are R6 Objects

    A Base Class for Traits that are R6 Objects

    -
    -

    Super class

    +
    +

    Super class

    RKernel::Trait -> R6Trait

    -
    -

    Public fields

    +
    +

    Public fields

    value

    An R6 object

    @@ -60,8 +74,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -127,22 +141,27 @@

    Arguments

    +
    + +

    -
    + diff --git a/reference/SelectionContainer.html b/reference/SelectionContainer.html index 158939c..2fa67bc 100644 --- a/reference/SelectionContainer.html +++ b/reference/SelectionContainer.html @@ -1,47 +1,61 @@ -Tabs and Accordions — SelectionContainer • RKernelTabs and Accordions — SelectionContainer • RKernel - Skip to contents + -
    -
    -
    -

    Tabs and Accordions

    - -
    SelectionContainer.Rd
    +
    -
    +

    Classes and constructor functions for tab and accordion widgets

    -
    -

    Usage

    + 
    Accordion(...)
 
 Tab(...)
@@ -49,25 +63,25 @@ 
    Usage
 Stack(...)
    -
    -

    Arguments

    +
    +

    Arguments

    ...

    Arguments passed to the superclass constructor

    -
    -

    Functions

    +
    +

    Functions

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

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

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

    -
    -

    Super classes

    + -
    -

    Public fields

    +
    +

    Public fields

    _titles

    A dictionary of strings, for internal use only

    @@ -82,8 +96,8 @@

    Public fields -

    Methods

    +
    +

    Methods

    Public methods

    @@ -127,7 +141,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    index

    An integer number.

    @@ -143,7 +157,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    index

    The index number of the element to be changed.

    @@ -163,7 +177,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    index

    The index number of the element to be enquired.

    @@ -179,7 +193,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    children

    A list of widgets

    @@ -199,7 +213,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -210,12 +224,12 @@

    Arguments -

    Super classes

    +
    +

    Super classes

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

    -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend.

    @@ -226,8 +240,8 @@

    Public fields

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -271,7 +285,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -282,12 +296,12 @@

    Arguments -

    Super classes

    + -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend.

    @@ -298,8 +312,8 @@

    Public fields

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -343,7 +357,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -354,12 +368,12 @@

    Arguments -

    Super classes

    + -
    -

    Public fields

    +
    +

    Public fields

    _model_name

    Name of the Javascript model in the frontend.

    @@ -375,8 +389,8 @@

    Public fields

    -
    -

    Methods

    +
    +

    Methods

    Public methods

    @@ -420,7 +434,7 @@

    Usage

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    @@ -432,22 +446,27 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/SelectionWidget.html b/reference/SelectionWidget.html index ddb2340..8095c31 100644 --- a/reference/SelectionWidget.html +++ b/reference/SelectionWidget.html @@ -1,47 +1,61 @@ -Selection widgets — SelectionWidget • RKernelSelection widgets — SelectionWidget • RKernel - Skip to contents + -
    -

      + +
      +
      +
      +

      Selection widgets

      -
      -
      -
      -
      -

      Selection widgets

      - -
      SelectionWidget.Rd
      +
      -
      +

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

      -
      -

      Usage

      + 
      SelectionWidget(options, value, ...)
 
 Dropdown(options, value, ...)
@@ -61,8 +75,8 @@ 
      Usage
 SelectionRangeSlider(options, value, ...)
      -
      -

      Arguments

      +
      +

      Arguments

      options

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

      @@ -75,8 +89,8 @@

      Arguments -

      Functions

      +
      +

      Functions

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

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

        • @@ -88,12 +102,12 @@

        Functions -

        Super classes

        + -
        -

        Public fields

        +
        +

        Public fields

        _options_labels

        A unicode vector of option labels.

        @@ -104,16 +118,16 @@

        Public fields -

        Active bindings

        +
        +

        Active bindings

        value

        The selected option

        -
        -

        Methods

        +
        +

        Methods

        Public methods

        @@ -154,7 +168,7 @@

        Usage

        -

        Arguments

        +

        Arguments

        index

        The index to be checked.

        @@ -170,7 +184,7 @@

        Usage

        -

        Arguments

        +

        Arguments

        options

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

        @@ -194,7 +208,7 @@

        Usage

        -

        Arguments

        +

        Arguments

        deep

        Whether to make a deep clone.

        @@ -205,12 +219,12 @@

        Arguments -

        Super classes

        +
        +

        Super classes

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

        -
        -

        Public fields

        +
        +

        Public fields

        _model_name

        Name of the Javascript model in the frontend.

        @@ -221,8 +235,8 @@

        Public fields

        -
        -

        Methods

        +
        +

        Methods

        Public methods

        @@ -263,7 +277,7 @@

        Usage

        -

        Arguments

        +

        Arguments

        deep

        Whether to make a deep clone.

        @@ -274,12 +288,12 @@

        Arguments -

        Super classes

        +
        +

        Super classes

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

        -
        -

        Public fields

        +
        +

        Public fields

        _model_name

        Name of the Javascript model in the frontend.

        @@ -290,8 +304,8 @@

        Public fields

        -
        -

        Methods

        +
        +

        Methods

        Public methods

        @@ -332,7 +346,7 @@

        Usage

        -

        Arguments

        +

        Arguments

        deep

        Whether to make a deep clone.

        @@ -343,12 +357,12 @@

        Arguments -

        Super classes

        +
        +

        Super classes

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

        -
        -

        Public fields

        +
        +

        Public fields

        _model_name

        Name of the Javascript model in the frontend.

        @@ -363,8 +377,8 @@

        Public fields

        -
        -

        Methods

        +
        +

        Methods

        Public methods

        @@ -405,7 +419,7 @@

        Usage

        -

        Arguments

        +

        Arguments

        deep

        Whether to make a deep clone.

        @@ -416,12 +430,12 @@

        Arguments -

        Super classes

        +
        +

        Super classes

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

        -
        -

        Public fields

        +
        +

        Public fields

        _model_name

        Name of the Javascript model in the frontend.

        @@ -436,8 +450,8 @@

        Public fields

        -
        -

        Methods

        +
        +

        Methods

        Public methods

        @@ -474,7 +488,7 @@

        Usage

        -

        Arguments

        +

        Arguments

        deep

        Whether to make a deep clone.

        @@ -485,12 +499,12 @@

        Arguments -

        Super classes

        +
        +

        Super classes

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

        -
        -

        Public fields

        +
        +

        Public fields

        _model_name

        Name of the Javascript model in the frontend.

        @@ -518,8 +532,8 @@

        Public fields

        -
        -

        Methods

        +
        +

        Methods

        Public methods

        @@ -560,7 +574,7 @@

        Usage

        -

        Arguments

        +

        Arguments

        deep

        Whether to make a deep clone.

        @@ -571,12 +585,12 @@

        Arguments -

        Super classes

        +
        +

        Super classes

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

        -
        -

        Public fields

        +
        +

        Public fields

        _model_name

        Name of the Javascript model in the frontend.

        @@ -607,8 +621,8 @@

        Public fields

        -
        -

        Methods

        +
        +

        Methods

        Public methods

        @@ -649,7 +663,7 @@

        Usage

        -

        Arguments

        +

        Arguments

        deep

        Whether to make a deep clone.

        @@ -660,12 +674,12 @@

        Arguments -

        Super classes

        +
        +

        Super classes

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

        -
        -

        Public fields

        +
        +

        Public fields

        _options_labels

        A unicode string vector with labels

        @@ -676,16 +690,16 @@

        Public fields

        -
        -

        Active bindings

        +
        +

        Active bindings

        value

        The selected option

        -
        -

        Methods

        +
        +

        Methods

        Public methods

        @@ -726,7 +740,7 @@

        Usage

        -

        Arguments

        +

        Arguments

        index

        An index, the index to be checked.

        @@ -742,7 +756,7 @@

        Usage
        -

        Arguments

        +

        Arguments

        options

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

        @@ -766,7 +780,7 @@

        Usage
        -

        Arguments

        +

        Arguments

        deep

        Whether to make a deep clone.

        @@ -777,12 +791,12 @@

        Arguments -

        Super classes

        +
        +

        Super classes

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

        -
        -

        Public fields

        +
        +

        Public fields

        _model_name

        Name of the Javascript model in the frontend.

        @@ -797,8 +811,8 @@

        Public fields

        -
        -

        Methods

        +
        +

        Methods

        Public methods

        @@ -839,7 +853,7 @@

        Usage
        -

        Arguments

        +

        Arguments

        deep

        Whether to make a deep clone.

        @@ -850,12 +864,12 @@

        Arguments -

        Super classes

        +
        +

        Super classes

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

        -
        -

        Public fields

        +
        +

        Public fields

        _model_name

        Name of the Javascript model in the frontend.

        @@ -886,8 +900,8 @@

        Public fields

        -
        -

        Methods

        +
        +

        Methods

        Public methods

        @@ -928,7 +942,7 @@

        Usage
        -

        Arguments

        +

        Arguments

        index

        An index, the index to be checked.

        @@ -944,7 +958,7 @@

        Usage
        -

        Arguments

        +

        Arguments

        options

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

        @@ -968,7 +982,7 @@

        Usage
        -

        Arguments

        +

        Arguments

        deep

        Whether to make a deep clone.

        @@ -980,22 +994,27 @@

        Arguments

        +
        + +

        -
        + diff --git a/reference/Sidecar.html b/reference/Sidecar.html index a304c5d..31d4d8f 100644 --- a/reference/Sidecar.html +++ b/reference/Sidecar.html @@ -1,67 +1,81 @@ -Sidecar widgets — Sidecar • RKernelSidecar widgets — Sidecar • RKernel - Skip to contents + -
        -
        -
        -

        Sidecar widgets

        - -
        Sidecar.Rd
        +
        -
        +

        Sidecar widgets - work only with Jupyter Lab

        -
        -

        Usage

        + 
        Sidecar(...)
        -
        -

        Arguments

        +
        +

        Arguments

        ...

        Arguments passed to the inializer

        -
        -

        Functions

        +
        +

        Functions

        • Sidecar(): A constructor for sidebar widgets

        -
        -

        Super classes

        + -
        -

        Public fields

        +
        +

        Public fields

        _model_name

        Name of the Javascript model in the frontend

        @@ -98,8 +112,8 @@

        Public fields -

        Methods

        +
        +

        Methods

        Public methods

        @@ -146,7 +160,7 @@

        Usage

        -

        Arguments

        +

        Arguments

        deep

        Whether to make a deep clone.

        @@ -158,22 +172,27 @@

        Arguments

        +
        + +
        -
        + diff --git a/reference/Slider.html b/reference/Slider.html index 27f59ac..94a0dba 100644 --- a/reference/Slider.html +++ b/reference/Slider.html @@ -1,47 +1,61 @@ -Sliders — Slider • RKernelSliders — Slider • RKernel - Skip to contents + -
        -
        -
        -

        Sliders

        - -
        Slider.Rd
        +
        -
        +

        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, ...)
@@ -53,8 +67,8 @@ 
        Usage
 FloatLogSlider(value = 1, min = 0, max = 40, base = 10, ...)
        -
        -

        Arguments

        +
        +

        Arguments

        value

        A floating point number, the current value of the slider

        @@ -75,8 +89,8 @@

        Arguments -

        Functions

        +
        +

        Functions

        • IntSlider(): An integer slider constructor

        • IntRangeSlider(): An integer range slider constructor

          • @@ -84,12 +98,12 @@

          Functions -

          Super classes

          +
          +

          Super classes

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

          -
          -

          Public fields

          +
          +

          Public fields

          _model_name

          Name of the Javascript frontend model

          @@ -100,8 +114,8 @@

          Public fields -

          Methods

          +
          +

          Methods

          Public methods

          @@ -138,7 +152,7 @@

          Usage

          -

          Arguments

          +

          Arguments

          deep

          Whether to make a deep clone.

          @@ -149,12 +163,12 @@

          Arguments -

          Super classes

          +
          +

          Super classes

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

          -
          -

          Public fields

          +
          +

          Public fields

          _model_name

          Name of the Javascript model in the frontend

          @@ -197,8 +211,8 @@

          Public fields

          -
          -

          Methods

          +
          +

          Methods

          Public methods

          @@ -242,7 +256,7 @@

          Usage

          -

          Arguments

          +

          Arguments

          deep

          Whether to make a deep clone.

          @@ -253,12 +267,12 @@

          Arguments -

          Super classes

          +
          +

          Super classes

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

          -
          -

          Public fields

          +
          +

          Public fields

          _model_name

          Name of the Javascript model in the frontend

          @@ -301,8 +315,8 @@

          Public fields

          -
          -

          Methods

          +
          +

          Methods

          Public methods

          @@ -346,7 +360,7 @@

          Usage

          -

          Arguments

          +

          Arguments

          deep

          Whether to make a deep clone.

          @@ -357,12 +371,12 @@

          Arguments -

          Super classes

          +
          +

          Super classes

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

          -
          -

          Public fields

          +
          +

          Public fields

          _model_name

          Name of the Javascript model in the frontend

          @@ -405,8 +419,8 @@

          Public fields

          -
          -

          Methods

          +
          +

          Methods

          Public methods

          @@ -450,7 +464,7 @@

          Usage

          -

          Arguments

          +

          Arguments

          deep

          Whether to make a deep clone.

          @@ -461,12 +475,12 @@

          Arguments -

          Super classes

          +
          +

          Super classes

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

          -
          -

          Public fields

          +
          +

          Public fields

          _model_name

          Name of the Javascript model in the frontend

          @@ -509,8 +523,8 @@

          Public fields

          -
          -

          Methods

          +
          +

          Methods

          Public methods

          @@ -554,7 +568,7 @@

          Usage

          -

          Arguments

          +

          Arguments

          deep

          Whether to make a deep clone.

          @@ -565,12 +579,12 @@

          Arguments -

          Super classes

          +
          +

          Super classes

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

          -
          -

          Public fields

          +
          +

          Public fields

          _model_name

          Name of the Javascript model in the frontend

          @@ -617,8 +631,8 @@

          Public fields

          -
          -

          Methods

          +
          +

          Methods

          Public methods

          @@ -662,7 +676,7 @@

          Usage

          -

          Arguments

          +

          Arguments

          deep

          Whether to make a deep clone.

          @@ -674,22 +688,27 @@

          Arguments

          +
          + +
          -
          + diff --git a/reference/StrEnum.html b/reference/StrEnum.html index ffc5155..3348886 100644 --- a/reference/StrEnum.html +++ b/reference/StrEnum.html @@ -1,73 +1,92 @@ -An Enumerated String Constructor — StrEnum • RKernelAn Enumerated String Constructor — StrEnum • RKernel - Skip to contents + -
          -
          -
          -

          An Enumerated String Constructor

          - -
          StrEnum.Rd
          +
          -
          +

          An Enumerated String Constructor

          -
          -

          Usage

          + 
          StrEnum(...)
          -
          -

          Arguments

          +
          +

          Arguments

          ...

          Arguments passed to the trait instance initializer

          -
          +
          + +
          -
          +

          Developed by Martin Elff.

          -
          +

          Site built with pkgdown 2.0.7.

          +

          Using preferably template.

          -
          +

          + diff --git a/reference/StrEnumClass.html b/reference/StrEnumClass.html index acf8037..b313fc3 100644 --- a/reference/StrEnumClass.html +++ b/reference/StrEnumClass.html @@ -1,55 +1,69 @@ -An Enumerated Strings Trait — StrEnumClass • RKernelAn Enumerated Strings Trait — StrEnumClass • RKernel - Skip to contents + -
          -
          -
          -

          An Enumerated Strings Trait

          - -
          StrEnumClass.Rd
          +
          -
          +

          An Enumerated Strings Trait

          An Enumerated Strings Trait

          -
          -

          Super classes

          +
          +

          Super classes

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

          -
          -

          Public fields

          +
          +

          Public fields

          enum

          a character vector

          @@ -60,8 +74,8 @@

          Public fields -

          Methods

          +
          +

          Methods

          Public methods

          @@ -131,22 +145,27 @@

          Arguments

          +
          + +

          -
          + diff --git a/reference/StringWidget.html b/reference/StringWidget.html index a2d8ba5..f93a9f4 100644 --- a/reference/StringWidget.html +++ b/reference/StringWidget.html @@ -1,47 +1,61 @@ -String widgets — StringWidget • RKernelString widgets — StringWidget • RKernel - Skip to contents + -
          -
          -
          -

          String widgets

          - -
          StringWidget.Rd
          +
          -
          +

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

          -
          -

          Usage

          + 
          LabelStyle(...)
 
 TextStyle(...)
@@ -67,8 +81,8 @@ 
          Usage
 Combobox(value = character(0), ...)
          -
          -

          Arguments

          +
          +

          Arguments

          ...

          Arguments passed to the inializer

          @@ -77,8 +91,8 @@

          Arguments -

          Functions

          +
          +

          Functions

          • LabelStyle(): The constructor for Label styles

          • TextStyle(): The constructor for Text styles

            • @@ -93,12 +107,12 @@

            Functions -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -122,8 +136,8 @@

            Public fields -

            Methods

            +
            +

            Methods

            Public methods

            @@ -160,7 +174,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -171,12 +185,12 @@

            Arguments -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -208,8 +222,8 @@

            Public fields

            -
            -

            Methods

            +
            +

            Methods

            Public methods

            @@ -246,7 +260,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -257,12 +271,12 @@

            Arguments -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -274,8 +288,8 @@

            Public fields

            -
            -

            Methods

            +
            +

            Methods

            Public methods

            @@ -312,7 +326,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -323,12 +337,12 @@

            Arguments -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -340,8 +354,8 @@

            Public fields

            -
            -

            Methods

            +
            +

            Methods

            Public methods

            @@ -378,7 +392,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -389,12 +403,12 @@

            Arguments -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -406,8 +420,8 @@

            Public fields

            -
            -

            Methods

            +
            +

            Methods

            Public methods

            @@ -444,7 +458,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -455,12 +469,12 @@

            Arguments -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -475,8 +489,8 @@

            Public fields

            -
            -

            Methods

            +
            +

            Methods

            Public methods

            @@ -517,7 +531,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -528,12 +542,12 @@

            Arguments -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -548,8 +562,8 @@

            Public fields

            -
            -

            Methods

            +
            +

            Methods

            Public methods

            @@ -590,7 +604,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -601,12 +615,12 @@

            Arguments -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -621,8 +635,8 @@

            Public fields

            -
            -

            Methods

            +
            +

            Methods

            Public methods

            @@ -663,7 +677,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -674,12 +688,12 @@

            Arguments -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -694,8 +708,8 @@

            Public fields

            -
            -

            Methods

            +
            +

            Methods

            Public methods

            @@ -736,7 +750,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -747,12 +761,12 @@

            Arguments -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -779,8 +793,8 @@

            Public fields

            -
            -

            Methods

            +
            +

            Methods

            Public methods

            @@ -821,7 +835,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -832,12 +846,12 @@

            Arguments -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -860,8 +874,8 @@

            Public fields

            -
            -

            Methods

            +
            +

            Methods

            Public methods

            @@ -911,7 +925,7 @@

            Usage
            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -922,12 +936,12 @@

            Arguments -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -938,8 +952,8 @@

            Public fields

            -
            -

            Methods

            +
            +

            Methods

            Public methods

            @@ -981,7 +995,7 @@

            Usage
            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -992,12 +1006,12 @@

            Arguments -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -1016,8 +1030,8 @@

            Public fields

            -
            -

            Methods

            +
            +

            Methods

            Public methods

            @@ -1059,7 +1073,7 @@

            Usage
            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -1071,22 +1085,27 @@

            Arguments

            +
            + +

            -
            + diff --git a/reference/TagsInput.html b/reference/TagsInput.html index dc90c46..a15d950 100644 --- a/reference/TagsInput.html +++ b/reference/TagsInput.html @@ -1,47 +1,61 @@ -Tags Input Widgets — TagsInput • RKernelTags Input Widgets — TagsInput • RKernel - Skip to contents + -
            -
            -
            -

            Tags Input Widgets

            - -
            TagsInput.Rd
            +
            -
            +

            Classes and constructors to great tag input widgets

            -
            -

            Usage

            + 
            TagsInput(...)
 
 ColorsInput(...)
@@ -51,26 +65,26 @@ 
            Usage
 IntsInput(...)
            -
            -

            Arguments

            +
            +

            Arguments

            ...

            Arguments passed to the inializer

            -
            -

            Functions

            +
            +

            Functions

            • TagsInput(): A taginput constructor

            • ColorsInput(): A color taginput constructor

            • FloatsInput(): A color taginput constructor

            • IntsInput(): A color taginput constructor

            -
            -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -98,8 +112,8 @@

            Public fields -

            Methods

            +
            +

            Methods

            Public methods

            @@ -141,7 +155,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            value

            A character string with one or more tags.

            @@ -157,7 +171,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            ...

            Arguments passed to the superclass initializer

            @@ -173,7 +187,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -184,12 +198,12 @@

            Arguments -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -208,8 +222,8 @@

            Public fields

            -
            -

            Methods

            +
            +

            Methods

            Public methods

            @@ -251,7 +265,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -262,12 +276,12 @@

            Arguments -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -282,8 +296,8 @@

            Public fields

            -
            -

            Methods

            +
            +

            Methods

            Public methods

            @@ -325,7 +339,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -336,12 +350,12 @@

            Arguments -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -360,8 +374,8 @@

            Public fields

            -
            -

            Methods

            +
            +

            Methods

            Public methods

            @@ -403,7 +417,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            value

            A character string with one or more tags.

            @@ -419,7 +433,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            ...

            Arguments passed to the superclass initializer

            @@ -439,7 +453,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -450,12 +464,12 @@

            Arguments -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -474,8 +488,8 @@

            Public fields

            -
            -

            Methods

            +
            +

            Methods

            Public methods

            @@ -517,7 +531,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -528,12 +542,12 @@

            Arguments -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -560,8 +574,8 @@

            Public fields

            -
            -

            Methods

            +
            +

            Methods

            Public methods

            @@ -603,7 +617,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -615,22 +629,27 @@

            Arguments

            +
            + +
            -
            + diff --git a/reference/TimeClass.html b/reference/TimeClass.html index e46a4df..e148a96 100644 --- a/reference/TimeClass.html +++ b/reference/TimeClass.html @@ -1,52 +1,67 @@ -Time Traitlets — TimeClass • RKernelTime Traitlets — TimeClass • RKernel - Skip to contents + -
            -
            -
            -

            Time Traitlets

            - -
            TimeClass.Rd
            +
            -
            +

            A class and constructor of time traitlets.

            -
            -

            Super class

            +
            +

            Super class

            RKernel::Trait -> TimeClass

            -
            -

            Public fields

            +
            +

            Public fields

            value

            A date.

            @@ -58,8 +73,8 @@

            Public fields -

            Methods

            +
            +

            Methods

            Public methods

            @@ -125,22 +140,27 @@

            Arguments

            +
            + +

            -
            + diff --git a/reference/TimePicker.html b/reference/TimePicker.html index 91c46b3..2562cac 100644 --- a/reference/TimePicker.html +++ b/reference/TimePicker.html @@ -1,67 +1,81 @@ -Time Picker Widgets — TimePicker • RKernelTime Picker Widgets — TimePicker • RKernel - Skip to contents + -
            -
            -
            -

            Time Picker Widgets

            - -
            TimePicker.Rd
            +
            -
            +

            An R6 class and constructor function for time picker widgets

            -
            -

            Usage

            + 
            TimePicker(...)
            -
            -

            Arguments

            +
            +

            Arguments

            ...

            Arguments passed to the inializer

            -
            -

            Functions

            +
            +

            Functions

            • TimePicker(): A constructor for dat picker widgets

            -
            -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -88,8 +102,8 @@

            Public fields -

            Methods

            +
            +

            Methods

            Public methods

            @@ -133,7 +147,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            value

            A date and time to be checked for validity

            @@ -149,7 +163,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            min

            A minimum date and time to be checked for validity

            @@ -165,7 +179,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            max

            A maximum date and time to be checked for validity

            @@ -182,7 +196,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            ...

            Arguments passed to the superclass initializer

            @@ -198,7 +212,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -210,22 +224,27 @@

            Arguments

            +
            + +
            -
            + diff --git a/reference/Togglebuttons.html b/reference/Togglebuttons.html index 644712b..925145b 100644 --- a/reference/Togglebuttons.html +++ b/reference/Togglebuttons.html @@ -1,70 +1,84 @@ -Tobble-Button Widgets — Togglebuttons • RKernelTobble-Button Widgets — Togglebuttons • RKernel - Skip to contents + -
            -
            -
            -

            Tobble-Button Widgets

            - -
            Togglebuttons.Rd
            +
            -
            +

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

            -
            -

            Usage

            + 
            ToggleButtonStyle(...)
 
 ToggleButton(...)
            -
            -

            Arguments

            +
            +

            Arguments

            ...

            Arguments passed to the inializer

            -
            -

            Functions

            +
            +

            Functions

            • ToggleButtonStyle(): The constructor for Togglebuttons styles

            • ToggleButton(): A toggle-button constructor

            -
            -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -104,8 +118,8 @@

            Public fields -

            Methods

            +
            +

            Methods

            Public methods

            @@ -142,7 +156,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -153,12 +167,12 @@

            Arguments -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -197,8 +211,8 @@

            Public fields

            -
            -

            Methods

            +
            +

            Methods

            Public methods

            @@ -239,7 +253,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -251,22 +265,27 @@

            Arguments

            +
            + +
            -
            + diff --git a/reference/Trace.html b/reference/Trace.html index 985ea19..0988b2d 100644 --- a/reference/Trace.html +++ b/reference/Trace.html @@ -1,61 +1,74 @@ -Step through a function — Trace • RKernelStep through a function — Trace • RKernel - Skip to contents + -
            -
            -
            -

            Step through a function

            - -
            Trace.Rd
            +
            -
            +

            The function Trace markes a function to be traced so that it will be evaluated step-by-step when called.

            -
            -

            Usage

            + 
            Trace(FUN)
            -
            -

            Arguments

            +
            +

            Arguments

            FUN

            the function to be traced.

            -
            -

            Details

            +
            +

            Details

            Trace differs in semantics from the function trace which allows to insert expressions at given positions within a function. @@ -64,22 +77,27 @@

            Detailsunrace(FUN)

            -
            +
            + +
            -

            + diff --git a/reference/Traitlets.html b/reference/Traitlets.html index 3881532..d45e83d 100644 --- a/reference/Traitlets.html +++ b/reference/Traitlets.html @@ -1,11 +1,17 @@ -Traitlets — Traitlets • RKernelTraitlets — Traitlets • RKernel - Skip to contents + -
            -
            -
            -

            Traitlets

            - -
            Traitlets.Rd
            +
            -
            +

            The class TraitClass brings (some of) the functionality of the traitlets framework on which the ipywidgets framework is @@ -58,15 +67,14 @@ object.

            -
            -

            Usage

            + 
            Trait(...)
 
 TraitInstance(Class, ...)
            -
            -

            Arguments

            +
            +

            Arguments

            ...

            Arguments passed to the inializer

            @@ -75,14 +83,14 @@

            Arguments

            -
            -

            Functions

            +
            +

            Functions

            • Trait(): A Baseline Trait Constructor

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

            -
            -

            Public fields

            +
            +

            Public fields

            value

            The value of the trait

            @@ -97,8 +105,8 @@

            Public fields -

            Methods

            +
            +

            Methods

            Public methods

            @@ -115,7 +123,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            value

            The value to be set

            @@ -143,7 +151,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            initial

            The initial value

            @@ -164,7 +172,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -176,22 +184,27 @@

            Arguments

            +
            + +
            -
            + diff --git a/reference/Unicode.html b/reference/Unicode.html index 21b6f94..c98459a 100644 --- a/reference/Unicode.html +++ b/reference/Unicode.html @@ -1,73 +1,92 @@ -A Unicode String Trait Constructor — Unicode • RKernelA Unicode String Trait Constructor — Unicode • RKernel - Skip to contents + -
            -
            -
            -

            A Unicode String Trait Constructor

            - -
            Unicode.Rd
            +
            -
            +

            A Unicode String Trait Constructor

            -
            -

            Usage

            + 
            Unicode(...)
            -
            -

            Arguments

            +
            +

            Arguments

            ...

            Arguments passed to the trait instance initializer

            -
            +
            + +
            -
            +

            Developed by Martin Elff.

            -
            +

            Site built with pkgdown 2.0.7.

            +

            Using preferably template.

            -
            +
            + diff --git a/reference/UnicodeClass.html b/reference/UnicodeClass.html index 6ab254f..b126ebd 100644 --- a/reference/UnicodeClass.html +++ b/reference/UnicodeClass.html @@ -1,56 +1,69 @@ -A Unicode String Vector Trait — UnicodeClass • RKernelA Unicode String Vector Trait — UnicodeClass • RKernel - Skip to contents + -
            -
            -
            -

            A Unicode String Vector Trait

            - -
            UnicodeClass.Rd
            +
            -
            +

            A Unicode String Vector Trait

            A Unicode String Vector Trait

            -
            -

            Usage

            + 
            # S3 method for Unicode
 as.character(x, ...)
            -
            -

            Arguments

            +
            +

            Arguments

            x

            A Unicode traitlet

            @@ -59,17 +72,17 @@

            Arguments -

            Functions

            +
            +

            Functions

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

            -
            -

            Super class

            +
            +

            Super class

            RKernel::Trait -> Unicode

            -
            -

            Public fields

            +
            +

            Public fields

            coerce

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

            @@ -88,8 +101,8 @@

            Public fields -

            Methods

            +
            +

            Methods

            Public methods

            @@ -107,7 +120,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            value

            The value to be assigned

            @@ -128,7 +141,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            initial

            An initial value

            @@ -156,7 +169,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -168,22 +181,27 @@

            Arguments

            +
            + +
            -
            + diff --git a/reference/Valid.html b/reference/Valid.html index 3c9d56a..58c87c2 100644 --- a/reference/Valid.html +++ b/reference/Valid.html @@ -1,67 +1,81 @@ -Validity Indicator Widgets — Valid • RKernelValidity Indicator Widgets — Valid • RKernel - Skip to contents + -
            -
            -
            -

            Validity Indicator Widgets

            - -
            Valid.Rd
            +
            -
            +

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

            -
            -

            Usage

            + 
            Valid(...)
            -
            -

            Arguments

            +
            +

            Arguments

            ...

            Arguments passed to the inializer

            -
            -

            Functions

            +
            +

            Functions

            • Valid(): A constructor for validity indicator widgets

            -
            -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend

            @@ -84,8 +98,8 @@

            Public fields -

            Methods

            +
            +

            Methods

            Public methods

            @@ -126,7 +140,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -138,22 +152,27 @@

            Arguments

            +
            + +
            -
            + diff --git a/reference/ValueWidgetClass.html b/reference/ValueWidgetClass.html index b52356d..72bf327 100644 --- a/reference/ValueWidgetClass.html +++ b/reference/ValueWidgetClass.html @@ -1,60 +1,75 @@ -Value widgets — ValueWidgetClass • RKernelValue widgets — ValueWidgetClass • RKernel - Skip to contents + -
            -
            -
            -

            Value widgets

            - -
            ValueWidgetClass.Rd
            +
            -
            +

            A base class for widgets that are connected with values

            -
            -

            Super classes

            + -
            -

            Public fields

            +
            +

            Public fields

            value

            A list or any other vector of values

            -
            -

            Methods

            +
            +

            Methods

            Public methods

            @@ -148,22 +163,27 @@

            Arguments

            +
            + +
            -
            + diff --git a/reference/Vector.html b/reference/Vector.html index 6ce3dab..81cb045 100644 --- a/reference/Vector.html +++ b/reference/Vector.html @@ -1,62 +1,76 @@ -Generic Vector Traitles — Vector • RKernelGeneric Vector Traitles — Vector • RKernel - Skip to contents + -
            -
            -
            -

            Generic Vector Traitles

            - -
            Vector.Rd
            +
            -
            +

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

            -
            -

            Usage

            + 
            Vector(...)
            -
            -

            Arguments

            +
            +

            Arguments

            ...

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

            -
            -

            Super class

            +
            +

            Super class

            RKernel::Trait -> Vector

            -
            -

            Public fields

            +
            +

            Public fields

            value

            A list

            @@ -67,8 +81,8 @@

            Public fields -

            Methods

            +
            +

            Methods

            Public methods

            @@ -87,7 +101,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            value

            A value to be assigned as the traitlet value

            @@ -104,7 +118,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            class

            String, optional common class

            @@ -124,7 +138,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -136,22 +150,27 @@

            Arguments

            +
            + +
            -
            + diff --git a/reference/View.html b/reference/View.html index 8833b2a..e034c46 100644 --- a/reference/View.html +++ b/reference/View.html @@ -1,56 +1,67 @@ -Invoke a Data Viewer — View • RKernelInvoke a Data Viewer — View • RKernel - Skip to contents - - -
            -
            -
            -

            Invoke a Data Viewer

            - -
            View.Rd
            +
            -
            +

            This is a re-implementation of View that works within Jupyter notebooks by leveraging the Jupyter widgets infrastructure or by using the DataTable 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)), ...)
 
 # S3 method for default
@@ -60,8 +71,8 @@ 
            Usage
 View(x, title = deparse(substitute(x)), ...)
            -
            -

            Arguments

            +
            +

            Arguments

            x

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

            @@ -75,22 +86,27 @@

            Arguments

            +
            + +
            -
            + diff --git a/reference/WidgetLink.html b/reference/WidgetLink.html index 6a0171d..169fd35 100644 --- a/reference/WidgetLink.html +++ b/reference/WidgetLink.html @@ -1,60 +1,72 @@ -Synchronize two Widgets Using a Link — WidgetLink • RKernelSynchronize two Widgets Using a Link — WidgetLink • RKernel - Skip to contents - - -
            -
            -
            -

            Synchronize two Widgets Using a Link

            - -
            WidgetLink.Rd
            +
            -
            +

            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

            +
            +

            Arguments

            source

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

            @@ -67,23 +79,23 @@

            Arguments -

            Details

            +
            +

            Details

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

            -
            -

            Functions

            +
            +

            Functions

            • WidgetLink(): The WidgetLink constructor function

            • DirectionalLink(): The WidgetLink constructor function

            -
            -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend.

            @@ -100,8 +112,8 @@

            Public fields -

            Methods

            +
            +

            Methods

            Public methods

            @@ -138,7 +150,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            source

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

            @@ -162,7 +174,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -173,20 +185,20 @@

            Arguments -

            Super classes

            +
            +

            Super classes

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

            -
            -

            Public fields

            +
            +

            Public fields

            _model_name

            Name of the Javascript model in the frontend.

            -
            -

            Methods

            +
            +

            Methods

            Public methods

            @@ -223,7 +235,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -235,22 +247,27 @@

            Arguments

            +
            + +
            -
            + diff --git a/reference/Widgets.html b/reference/Widgets.html index 8ad95ba..d56f4a5 100644 --- a/reference/Widgets.html +++ b/reference/Widgets.html @@ -1,67 +1,81 @@ -A Widget Base Class — Widgets • RKernelA Widget Base Class — Widgets • RKernel - Skip to contents + -
            -
            -
            -

            A Widget Base Class

            - -
            Widgets.Rd
            +
            -
            +

            The base class from which all widget classes are derived

            -
            -

            Usage

            + 
            Widget(...)
            -
            -

            Arguments

            +
            +

            Arguments

            ...

            Arguments passed to the inializer

            -
            -

            Functions

            +
            +

            Functions

            • Widget(): A Widget Constructor Function

            -
            -

            Super class

            +
            +

            Super class

            RKernel::HasTraits -> Widget

            -
            -

            Public fields

            +
            +

            Public fields

            _model_id

            Identifyer of the frontend Javascript object

            @@ -125,16 +139,16 @@

            Public fields -

            Active bindings

            +
            +

            Active bindings

            comm

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

            -
            -

            Methods

            +
            +

            Methods

            Public methods

            @@ -171,7 +185,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            ...

            Values used for initialization

            @@ -215,7 +229,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            keys

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

            @@ -231,7 +245,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            state

            A list of values for the synchronized traits

            @@ -247,7 +261,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            keys

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

            @@ -267,7 +281,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            content

            Some user-defined information to be send to the frontend

            @@ -295,7 +309,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            comm

            The 'comm' object that is opened

            @@ -315,7 +329,7 @@

            Usage
            -

            Arguments

            +

            Arguments

            comm

            The 'comm' object via which the message is received

            @@ -337,7 +351,7 @@

            Usage
            -

            Arguments

            +

            Arguments

            msg

            A comm message

            @@ -353,7 +367,7 @@

            Usage
            -

            Arguments

            +

            Arguments

            content

            The data received

            @@ -369,7 +383,7 @@

            Usage
            -

            Arguments

            +

            Arguments

            handler

            A handler function

            @@ -389,7 +403,7 @@

            Usage
            -

            Arguments

            +

            Arguments

            event

            A character that describes the event

            @@ -413,7 +427,7 @@

            Usage
            -

            Arguments

            +

            Arguments

            event

            A string that describes the event

            @@ -433,7 +447,7 @@

            Usage
            -

            Arguments

            +

            Arguments

            handler

            A handler function

            @@ -461,7 +475,7 @@

            Usage
            -

            Arguments

            +

            Arguments

            msg

            The message

            @@ -489,7 +503,7 @@

            Usage
            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -501,22 +515,27 @@

            Arguments

            +
            + +

            -
            + diff --git a/reference/add_displayed_classes.html b/reference/add_displayed_classes.html index 2dd7578..0bec00f 100644 --- a/reference/add_displayed_classes.html +++ b/reference/add_displayed_classes.html @@ -1,79 +1,96 @@ -Add a Class to the 'Displayed' Ones — add_displayed_classes • RKernelAdd a Class to the 'Displayed' Ones — add_displayed_classes • RKernel - Skip to contents - - -
            -
            -
            -

            Add a Class to the 'Displayed' Ones

            - -
            add_displayed_classes.Rd
            +
            -
            +

            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

            +
            +

            Arguments

            x

            A character string, the name of a class.

            -
            +
            + +

            -
            +

            Developed by Martin Elff.

            -
            +

            Site built with pkgdown 2.0.7.

            +

            Using preferably template.

            -
            +
            + diff --git a/reference/add_paged_classes.html b/reference/add_paged_classes.html index a05e8f6..56222b9 100644 --- a/reference/add_paged_classes.html +++ b/reference/add_paged_classes.html @@ -1,79 +1,96 @@ -Add a Class to the 'Paged' Ones — add_paged_classes • RKernelAdd a Class to the 'Paged' Ones — add_paged_classes • RKernel - Skip to contents - - -
            -
            -
            -

            Add a Class to the 'Paged' Ones

            - -
            add_paged_classes.Rd
            +
            -
            +

            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

            +
            +

            Arguments

            x

            A character string, the name of a class.

            -
            +
            + +

            -
            +

            Developed by Martin Elff.

            -
            +

            Site built with pkgdown 2.0.7.

            +

            Using preferably template.

            -
            +
            + diff --git a/reference/alert.html b/reference/alert.html index f84bb1b..0729da3 100644 --- a/reference/alert.html +++ b/reference/alert.html @@ -1,76 +1,94 @@ -Create an alert in the frontend — alert • RKernelCreate an alert in the frontend — alert • RKernel - Skip to contents + -
            -
            -
            -

            Create an alert in the frontend

            - -
            alert.Rd
            +
            -
            +

            Creates Javascript code and sends it to the frontend that opens an alert box in the browser.

            -
            -

            Usage

            + 
            alert(text)
            -
            -

            Arguments

            +
            +

            Arguments

            text

            A character string with the text that appears in the

            -
            +
            + +

            -
            +

            Developed by Martin Elff.

            -
            +

            Site built with pkgdown 2.0.7.

            +

            Using preferably template.

            -
            +
            + diff --git a/reference/cell.options.html b/reference/cell.options.html index db82235..a83907b 100644 --- a/reference/cell.options.html +++ b/reference/cell.options.html @@ -1,75 +1,94 @@ -Set options or graphics parameters locally for the current jupyter notebook cell — cell.options • RKernelSet options or graphics parameters locally for the current jupyter notebook cell — cell.options • RKernel - Skip to contents + -
            -
            -
            -

            Set options or graphics parameters locally for the current jupyter notebook cell

            - -
            cell.options.Rd
            +
            -
            +

            Set options or graphics parameters locally for the current jupyter notebook cell

            -
            -

            Usage

            + 
            cell.options(...)
 
 cell.par(...)
            -
            -

            Arguments

            +
            +

            Arguments

            ...

            Graphics parameters, see options.

            -
            +
            + +

            -
            +

            Developed by Martin Elff.

            -
            +

            Site built with pkgdown 2.0.7.

            +

            Using preferably template.

            -
            +
            + diff --git a/reference/dataTable.html b/reference/dataTable.html index 97584b1..982802e 100644 --- a/reference/dataTable.html +++ b/reference/dataTable.html @@ -1,50 +1,63 @@ -HTML Tables with Interactive Controls — dataTable • RKernel" + ); + } +HTML Tables with Interactive Controls — dataTable • RKernel - Skip to contents + -
            -
            -
            -

            HTML Tables with Interactive Controls

            - -
            dataTable.Rd
            +
            -
            +

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

            -
            -

            Usage

            + 
            dataTable(x, ...)
 
 # S3 method for default
@@ -63,8 +76,8 @@ 
            Usage
 )
            -
            -

            Arguments

            +
            +

            Arguments

            x

            A "dataTable" object

            @@ -86,24 +99,24 @@

            Arguments -

            Methods (by class)

            +
            +

            Methods (by class)

            • dataTable(default): Default method

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

            -
            -

            Methods (by generic)

            +
            +

            Methods (by generic)

            • display_data(dataTable): dataTable method for display_data

            -
            -

            Functions

            +
            +

            Functions

            • dataTable(): A dataTable constructor

            -
            -

            Public fields

            +
            +

            Public fields

            w

            A container widget or NULL

            @@ -174,8 +187,8 @@

            Public fields -

            Methods

            +
            +

            Methods

            Public methods

            @@ -195,7 +208,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            obj

            The object to be displayed

            @@ -263,7 +276,7 @@

            Usage

            -

            Arguments

            +

            Arguments

            deep

            Whether to make a deep clone.

            @@ -275,22 +288,27 @@

            Arguments

            +
            + +
            -
            + diff --git a/reference/dictionary.html b/reference/dictionary.html index 81f4d4b..b2d0351 100644 --- a/reference/dictionary.html +++ b/reference/dictionary.html @@ -1,56 +1,67 @@ -A data type analogous to Python dictionaries — dictionary • RKernel" + ); + } +A data type analogous to Python dictionaries — dictionary • RKernel - Skip to contents - - -
            -
            -
            -

            A data type analogous to Python dictionaries

            - -
            dictionary.Rd
            +
            -
            +

            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 dictionary
@@ -63,8 +74,8 @@ 
            Usage
 print(x, force = FALSE, ...)
            -
            -

            Arguments

            +
            +

            Arguments

            ...

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

            @@ -87,35 +98,40 @@

            Arguments -

            Methods (by generic)

            +
            +

            Methods (by generic)

            • [: Get an element from a dictionary

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

            • print(dictionary): Print a dictionary

            -
            -

            Functions

            +
            +

            Functions

            • dictionary(): A dictionary constructor

            -

            +
            + +
            -
            +

            Developed by Martin Elff.

            -
            +

            Site built with pkgdown 2.0.7.

            +

            Using preferably template.

            -
            +

            + diff --git a/reference/display.html b/reference/display.html index c26ca99..c890529 100644 --- a/reference/display.html +++ b/reference/display.html @@ -1,73 +1,92 @@ -Display an R Object — display • RKernelDisplay an R Object — display • RKernel - Skip to contents + -
            -
            -
            -

            Display an R Object

            - -
            display.Rd
            +
            -
            +

            Display an R Object

            -
            -

            Usage

            + 
            display(...)
            -
            -

            Arguments

            +
            +

            Arguments

            ...

            Arguments passed to 'display_data' methods

            -
            +
            + +
            -
            +

            Developed by Martin Elff.

            -
            +

            Site built with pkgdown 2.0.7.

            +

            Using preferably template.

            -
            +
            + diff --git a/reference/display_data.html b/reference/display_data.html index 4199f83..583bca8 100644 --- a/reference/display_data.html +++ b/reference/display_data.html @@ -1,47 +1,61 @@ -Prepare an R Object for Being Displayed — display_data • RKernelPrepare an R Object for Being Displayed — display_data • RKernel - Skip to contents + -
            -
            -
            -

            Prepare an R Object for Being Displayed

            - -
            display_data.Rd
            +
            -
            +

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

            -
            -

            Usage

            + 
            display_data(x, ...)
 
 # S3 method for default
@@ -142,8 +156,8 @@ 
            Usage
 display_data(x, ..., metadata = emptyNamedList, id = uuid(), update = FALSE)
            -
            -

            Arguments

            +
            +

            Arguments

            x

            An object

            @@ -197,14 +211,14 @@

            Arguments

            -
            -

            Value

            +
            +

            Value

            An object of class "display_data"

            -
            -

            Methods (by class)

            +
            +

            Methods (by class)

            -
            -

            Methods (by generic)

            +
            +

            Methods (by generic)

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

            -
            +
            + +
            -
            +

            Developed by Martin Elff.

            -
            +

            Site built with pkgdown 2.0.7.

            +

            Using preferably template.

            -
            +
            + diff --git a/reference/display_id.html b/reference/display_id.html index 5d4fcb7..76a918a 100644 --- a/reference/display_id.html +++ b/reference/display_id.html @@ -1,50 +1,63 @@ -Get the id of an object display — display_id • RKernelGet the id of an object display — display_id • RKernel - Skip to contents + -
            -
            -
            -

            Get the id of an object display

            - -
            display_id.Rd
            +
            -
            +

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

            -
            -

            Usage

            + 
            display_id(x)
 
 # S3 method for display_data
@@ -54,41 +67,46 @@ 
            Usage
 display_id(x)
            -
            -

            Arguments

            +
            +

            Arguments

            x

            An object of class "display_data" or "update_display_data"

            -
            -

            Value

            +
            +

            Value

            a character string with the id.

            -
            -

            Methods (by class)

            +
            +

            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

            -
            +
            + +

            -
            +

            Developed by Martin Elff.

            -
            +

            Site built with pkgdown 2.0.7.

            +

            Using preferably template.

            -
            +
            + diff --git a/reference/envBrowser.html b/reference/envBrowser.html index 054ef01..2280686 100644 --- a/reference/envBrowser.html +++ b/reference/envBrowser.html @@ -1,47 +1,61 @@ -Environment Browser Widgets — envBrowser • RKernelEnvironment Browser Widgets — envBrowser • RKernel - Skip to contents + -
            -
            -
            -

            Environment Browser Widgets

            - -
            envBrowser.Rd
            +
            -
            +

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

            -
            -

            Usage

            + 
            envBrowser(
   pos = -1,
   name = NULL,
@@ -53,8 +67,8 @@ 
            Usage
 )
            -
            -

            Arguments

            +
            +

            Arguments

            pos

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

            @@ -89,22 +103,27 @@

            Arguments

            +
            + +
            -
            + diff --git a/reference/help.start.html b/reference/help.start.html index 8f53685..3cc0a55 100644 --- a/reference/help.start.html +++ b/reference/help.start.html @@ -1,50 +1,63 @@ -Start interactive help system — help.start • RKernelStart interactive help system — help.start • RKernel - Skip to contents + -
            -
            -
            -

            Start interactive help system

            - -
            help.start.Rd
            +
            -
            +

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

            -
            -

            Usage

            + 
            help.start(
   update = FALSE,
   gui = "irrelevant",
@@ -53,8 +66,8 @@ 
            Usage
 )
            -
            -

            Arguments

            +
            +

            Arguments

            update

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

            @@ -76,22 +89,27 @@

            Arguments

            +
            + +
            -
            + diff --git a/reference/index.html b/reference/index.html index 15d1dfa..6cc81cb 100644 --- a/reference/index.html +++ b/reference/index.html @@ -1,642 +1,516 @@ -Function reference • RKernelFunction reference • RKernel - Skip to contents + -
            -
            -
            -

            Function reference

            +
            +
            - - - -
            - - cell.options() cell.par() -
            -
            Set options or graphics parameters locally for the current jupyter notebook cell
            -
            - - dump.frames() Debugger() -
            -
            Interactive Debugger
            -
            - - dictionary() `[`(<dictionary>) `[<-`(<dictionary>) print(<dictionary>) -
            -
            A data type analogous to Python dictionaries
            -
            - - with(<Context>) -
            -
            Evalute expressions within a context
            -
            -

            Internal functions

            - - +
            +
            +
            +

            Reference

            +
            - -
            - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +

            Display facilities

            +

            +
            +

            CSS()

            +

            Send CSS code to the frontend

            +

            IFrame()

            +

            Include HTML content using in an iframe

            +

            Javascript()

            +

            Send Javascript to the frontend

            +

            View()

            +

            Invoke a Data Viewer

            +

            add_displayed_classes()

            +

            Add a Class to the 'Displayed' Ones

            +

            add_paged_classes()

            +

            Add a Class to the 'Paged' Ones

            +

            alert()

            +

            Create an alert in the frontend

            +

            display()

            +

            Display an R Object

            +

            display_data() update(<display_data>)

            +

            Prepare an R Object for Being Displayed

            +

            envBrowser()

            +

            Environment Browser Widgets

            +

            help.start()

            +

            Start interactive help system

            +

            ls_str()

            +

            A HTML version of 'ls.str()'

            +

            raw_html()

            +

            Send raw HTML code to the frontend

            +

            remove_displayed_classes()

            +

            Remove a Class to the 'Displayed' Ones

            +

            remove_paged_classes()

            +

            Remove a Class to the 'Paged' Ones

            +

            Traitlets

            +

            +
            +

            Boolean()

            +

            Boolean Traitlets

            +

            Bytes()

            +

            Raw Bytes Traitlets

            +

            Date() as.Date(<DateClass>)

            +

            Date Traitlets

            +

            Datetime() Time()

            +

            Datetime Traitlets

            +

            DatetimePicker() NaiveDatetimePicker()

            +

            Datetime Picker Widgets

            +

            Dict()

            +

            Dictionary Traitlets

            +

            Fixed()

            +

            Fixed Arguements in Interactive Widgets

            +

            Float() as.integer(<Float>) as.numeric(<Float>)

            +

            Floating Point Number Traitlets

            +

            Integer() as.integer(<Integer>) as.numeric(<Integer>) to_json(<Integer>)

            +

            Integer Traitlets

            +

            List()

            +

            List Traitlets

            +

            Page()

            +

            Display an object using the Jupyter notebook pager

            +

            StrEnum()

            +

            An Enumerated String Constructor

            +

            StrEnumClass

            +

            An Enumerated Strings Trait

            +

            TimeClass

            +

            Time Traitlets

            +

            Trait() TraitInstance()

            +

            Traitlets

            +

            Unicode()

            +

            A Unicode String Trait Constructor

            +

            as.character(<Unicode>)

            +

            A Unicode String Vector Trait

            +

            Vector()

            +

            Generic Vector Traitles

            +

            Widgets

            +

            +
            +

            BoundedFloatRangeWidget()

            +

            Widgets for Floating Point Number Ranges

            +

            BoundedFloatText()

            +

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

            +

            BoundedFloatWidget()

            +

            Widgets for Bounded Floating Point Numbers

            +

            BoundedIntText()

            +

            Widgets for Text Elements with Integer Numbers Bounded within an Interval

            +

            BoundedIntWidget() BoundedIntRangeWidget()

            +

            Widgets for Bounded Integer Numbers

            +

            BoundedLogFloatWidget()

            +

            Widgets for Bounded Floating Point Numbers on a logarithmic scale

            +

            Box() HBox() VBox() GridBox()

            +

            Box Containers

            +

            Button() ButtonStyle()

            +

            Buttons

            +

            CheckboxStyle() Checkbox()

            +

            Checkbox Widgets

            +

            ColorPicker()

            +

            Color picker widgets

            +

            Color()

            +

            A Color String Trait

            +

            CoreWidgetClass

            +

            Yet Another Widget Class

            +

            DOMWidget()

            +

            A Base Class for DOM Widgets

            +

            DatePicker()

            +

            Date Picker Widgets

            +

            DescriptionStyle()

            +

            Styling of Decscription Widgets

            +

            DescriptionWidget()

            +

            Decscription Widgets

            +

            FileUpload()

            +

            File Upload Widgets

            +

            FloatText()

            +

            Widgets for Text Elements with Floating Point Numbers

            +

            FloatWidget()

            +

            Widgets for Floating Point Numbers

            +

            IntText()

            +

            Widgets for Text Elements with Integer Numbers

            +

            IntWidget()

            +

            Widgets for Integer Numbers

            +

            LaTeXMath()

            +

            Send LaTeX math to the frontend

            +

            Layout()

            +

            Widget Layout Manipulation

            +

            AppLayout() GridspecLayout() `[`(<GridspecLayout>) `[<-`(<GridspecLayout>) TwoByTwoLayout()

            +

            Widget Layout Templates

            +

            ImageWidget() VideoWidget() AudioWidget()

            +

            Media widgets

            +

            OutputWidget() with(<OutputWidget>)

            +

            Widgets to receive output

            +

            Play()

            +

            A Player Widget

            +

            SVGWidget() with(<SVGWidget>) PlotWidget()

            +

            Widgets to receive plots graphics

            +

            ProgressStyle() IntProgress() FloatProgress()

            +

            Progress bars

            +

            Accordion() Tab() Stack()

            +

            Tabs and Accordions

            +

            SelectionWidget() Dropdown() RadioButtons() ListBox() ToggleButtons() SelectionSlider() MultipleSelectionWidget() ListBoxMultiple() SelectionRangeSlider()

            +

            Selection widgets

            +

            Sidecar()

            +

            Sidecar widgets

            +

            IntSlider() IntRangeSlider() FloatSlider() FloatRangeSlider() FloatLogSlider()

            +

            Sliders

            +

            LabelStyle() TextStyle() HTMLStyle() HTMLMathStyle() StringWidget() HTML() HTMLMath() Label() Textarea() TextWidget() PasswordWidget() Combobox()

            +

            String widgets

            +

            TagsInput() ColorsInput() FloatsInput() IntsInput()

            +

            Tags Input Widgets

            +

            TimePicker()

            +

            Time Picker Widgets

            +

            ToggleButtonStyle() ToggleButton()

            +

            Tobble-Button Widgets

            +

            Valid()

            +

            Validity Indicator Widgets

            +

            ValueWidgetClass

            +

            Value widgets

            +

            WidgetLink() DirectionalLink()

            +

            Synchronize two Widgets Using a Link

            +

            Widget()

            +

            A Widget Base Class

            +

            dataTable() display_data(<dataTable>)

            +

            HTML Tables with Interactive Controls

            +

            Interactions

            +

            +
            +

            BreakPoint()

            +

            Breakpoints

            +

            Trace()

            +

            Step through a function

            +

            interactive_output() mkWidgets() Interactive() interact()

            +

            Interactions Using Widgets

            +

            mkWidget()

            +

            Controls for Interactive Widgets

            +

            Utilities

            +

            +
            +

            cell.options() cell.par()

            +

            Set options or graphics parameters locally for the current jupyter notebook cell

            +

            dump.frames() Debugger()

            +

            Interactive Debugger

            +

            dictionary() `[`(<dictionary>) `[<-`(<dictionary>) print(<dictionary>)

            +

            A data type analogous to Python dictionaries

            +

            with(<Context>)

            +

            Evalute expressions within a context

            +

            Internal functions

            +

            +
            +

            CallbackDispatcher()

            +

            A Dispatcher for Callbacks

            +

            Comm()

            +

            Comms - connections between the kernel and the frontend

            +

            CommManager()

            +

            A Manager for Comms

            +

            Context

            +

            Context Objects

            +

            Evaluator

            +

            The Evaluator Class

            +

            EventManager()

            +

            A Manager for Comms

            +

            Graphics()

            +

            Send a graphics file to the frontend

            +

            HasTraits

            +

            The Base Class of Objects with Traits

            +

            Kernel

            +

            The Kernel Class

            +

            R6Class_()

            +

            R6 Objects That Are Not Locked

            +

            R6Instance()

            +

            A Generic Constructor for R6 Object Traits

            +

            R6TraitClass

            +

            A Base Class for Traits that are R6 Objects

            +

            display_id()

            +

            Get the id of an object display

            +

            install() installspec()

            +

            install the R Kernel

            +

            main()

            +

            Main entry point of the package

            +

            register_magic_handler()

            +

            Register a handler for magics

            +

            add_service() remove_service()

            +

            Add or remove services

            +

            sharedHelpServer

            +

            R6 objects that run a help server

            +

            to_json()

            +

            A Genereric Converter to JSON

            +

            tracing_source()

            +

            Step through a scripted being sourced

            +

            virtable_widget() fmt_tab_section()

            +

            Widgets to show tabular data

            -
            - - CallbackDispatcher() -
            -
            A Dispatcher for Callbacks
            -
            - - Comm() -
            -
            Comms - connections between the kernel and the frontend
            -
            - - CommManager() -
            -
            A Manager for Comms
            -
            - - Context -
            -
            Context Objects
            -
            - - Evaluator -
            -
            The Evaluator Class
            -
            - - EventManager() -
            -
            A Manager for Comms
            -
            - - Graphics() -
            -
            Send a graphics file to the frontend
            -
            - - HasTraits -
            -
            The Base Class of Objects with Traits
            -
            - - Kernel -
            -
            The Kernel Class
            -
            - - R6Class_() -
            -
            R6 Objects That Are Not Locked
            -
            - - R6Instance() -
            -
            A Generic Constructor for R6 Object Traits
            -
            - - R6TraitClass -
            -
            A Base Class for Traits that are R6 Objects
            -
            - - display_id() -
            -
            Get the id of an object display
            -
            - - install() installspec() -
            -
            install the R Kernel
            -
            - - main() -
            -
            Main entry point of the package
            -
            - - register_magic_handler() -
            -
            Register a handler for magics
            -
            - - add_service() remove_service() -
            -
            Add or remove services
            -
            - - sharedHelpServer -
            -
            R6 objects that run a help server
            -
            - - to_json() -
            -
            A Genereric Converter to JSON
            -
            - - tracing_source() -
            -
            Step through a scripted being sourced
            -
            - - virtable_widget() fmt_tab_section() -
            -
            Widgets to show tabular data
            -
            -
            + +
            -
            +

            Developed by Martin Elff.

            -
            +

            Site built with pkgdown 2.0.7.

            +

            Using preferably template.

            -
            +
            + diff --git a/reference/install.html b/reference/install.html index fcdfcac..47dd292 100644 --- a/reference/install.html +++ b/reference/install.html @@ -1,54 +1,68 @@ -install the R Kernel — install • RKernelinstall the R Kernel — install • RKernel - Skip to contents + -
            -
            -
            -

            install the R Kernel

            - -
            install.Rd
            +
            -
            +

            install the R Kernel

            -
            -

            Usage

            + 
            install()
 
 installspec(user = TRUE, prefix = NULL, single_blas = FALSE)
            -
            -

            Arguments

            +
            +

            Arguments

            user

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

            @@ -57,28 +71,33 @@

            Arguments -

            Functions

            +
            +

            Functions

            • installspec(): Install the R Kernel spec

            -

            +
            + +
            -
            +

            Developed by Martin Elff.

            -
            +

            Site built with pkgdown 2.0.7.

            +

            Using preferably template.

            -
            +
            + diff --git a/reference/interaction.html b/reference/interaction.html index defe927..70ac298 100644 --- a/reference/interaction.html +++ b/reference/interaction.html @@ -1,47 +1,61 @@ -Interactions Using Widgets — interaction • RKernelInteractions Using Widgets — interaction • RKernel - Skip to contents + -
            -
            -
            -

            Interactions Using Widgets

            - -
            interaction.Rd
            +
            -
            +

            A variety of functions to create interactive function calls

            -
            -

            Usage

            + 
            interactive_output(
   FUN,
   controls,
@@ -72,8 +86,8 @@ 
            Usage
 )
            -
            -

            Arguments

            +
            +

            Arguments

            FUN

            A function to called with arguments manipulated using interactive widgets.

            @@ -130,22 +144,27 @@

            Arguments

            +
            + +
            -
            + diff --git a/reference/ls_str.html b/reference/ls_str.html index 6b27c91..ca3058c 100644 --- a/reference/ls_str.html +++ b/reference/ls_str.html @@ -1,52 +1,66 @@ -A HTML version of 'ls.str()' — ls_str • RKernelA HTML version of 'ls.str()' — ls_str • RKernel - Skip to contents + -
            -
            -
            -

            A HTML version of 'ls.str()'

            - -
            ls_str.Rd
            +
            -
            +

            This function is deprecated. Use envBrowser instead.

            -
            -

            Usage

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

            Arguments

            +
            +

            Arguments

            pos

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

            @@ -71,27 +85,32 @@

            Arguments -

            See also

            +
            +

            See also

            ls.str

            -

            +
            + +
            -
            +

            Developed by Martin Elff.

            -
            +

            Site built with pkgdown 2.0.7.

            +

            Using preferably template.

            -
            +
            + diff --git a/reference/main.html b/reference/main.html index 3d12110..328972b 100644 --- a/reference/main.html +++ b/reference/main.html @@ -1,69 +1,88 @@ -Main entry point of the package — main • RKernel" + ); + } +Main entry point of the package — main • RKernel - Skip to contents + -
            -
            -
            -

            Main entry point of the package

            - -
            main.Rd
            +
            -
            +

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

            -
            -

            Usage

            + 
            main()
            -
            +
            + +
            -
            +

            Developed by Martin Elff.

            -
            +

            Site built with pkgdown 2.0.7.

            +

            Using preferably template.

            -
            +
            + diff --git a/reference/mkWidget.html b/reference/mkWidget.html index 21a30b0..edcdbe3 100644 --- a/reference/mkWidget.html +++ b/reference/mkWidget.html @@ -1,50 +1,63 @@ -Controls for Interactive Widgets — mkWidget • RKernelControls for Interactive Widgets — mkWidget • RKernel - Skip to contents + -
            -
            -
            -

            Controls for Interactive Widgets

            - -
            mkWidget.Rd
            +
            -
            +

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

            -
            -

            Usage

            + 
            mkWidget(x, ...)
 
 # S3 method for integer
@@ -66,8 +79,8 @@ 
            Usage
 mkWidget(x, ...)
            -
            -

            Arguments

            +
            +

            Arguments

            x

            an object

            @@ -80,8 +93,8 @@

            Arguments -

            Details

            +
            +

            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 @@ -89,22 +102,27 @@

            DetailsmkWidget returns it as is.

            -

            +
            + +
            -
            + diff --git a/reference/raw_html.html b/reference/raw_html.html index ec3537c..8249d6e 100644 --- a/reference/raw_html.html +++ b/reference/raw_html.html @@ -1,55 +1,68 @@ -Send raw HTML code to the frontend — raw_html • RKernelSend raw HTML code to the frontend — raw_html • RKernel - Skip to contents + -
            -
            -
            -

            Send raw HTML code to the frontend

            - -
            raw_html.Rd
            +
            -
            +

            Send raw HTML code in a character string to the frontend

            -
            -

            Usage

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

            Arguments

            +
            +

            Arguments

            text

            A character string with LaTeX code for math

            @@ -63,22 +76,27 @@

            Arguments

            +
            + +
            -
            + diff --git a/reference/register_magic_handler.html b/reference/register_magic_handler.html index 48b8876..ecf70ba 100644 --- a/reference/register_magic_handler.html +++ b/reference/register_magic_handler.html @@ -1,55 +1,68 @@ -Register a handler for magics — register_magic_handler • RKernelRegister a handler for magics — register_magic_handler • RKernel - Skip to contents + -
            -
            -
            -

            Register a handler for magics

            - -
            register_magic_handler.Rd
            +
            -
            +

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

            -
            -

            Usage

            + 
            register_magic_handler(magic, handler)
            -
            -

            Arguments

            +
            +

            Arguments

            magic

            A character string that selects a handler

            @@ -60,22 +73,27 @@

            Arguments

            +
            + +
            -
            + diff --git a/reference/remove_displayed_classes.html b/reference/remove_displayed_classes.html index 56678fd..7419912 100644 --- a/reference/remove_displayed_classes.html +++ b/reference/remove_displayed_classes.html @@ -1,79 +1,96 @@ -Remove a Class to the 'Displayed' Ones — remove_displayed_classes • RKernelRemove a Class to the 'Displayed' Ones — remove_displayed_classes • RKernel - Skip to contents - - -
            -
            -
            -

            Remove a Class to the 'Displayed' Ones

            - -
            remove_displayed_classes.Rd
            +
            -
            +

            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

            +
            +

            Arguments

            x

            A character string, the name of a class.

            -
            +
            + +
            -
            +

            Developed by Martin Elff.

            -
            +

            Site built with pkgdown 2.0.7.

            +

            Using preferably template.

            -
            +
            + diff --git a/reference/remove_paged_classes.html b/reference/remove_paged_classes.html index eeff234..38beaf8 100644 --- a/reference/remove_paged_classes.html +++ b/reference/remove_paged_classes.html @@ -1,79 +1,96 @@ -Remove a Class to the 'Paged' Ones — remove_paged_classes • RKernelRemove a Class to the 'Paged' Ones — remove_paged_classes • RKernel - Skip to contents - - -
            -
            -
            -

            Remove a Class to the 'Paged' Ones

            - -
            remove_paged_classes.Rd
            +
            -
            +

            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

            +
            +

            Arguments

            x

            A character string, the name of a class.

            -
            +
            + +
            -
            +

            Developed by Martin Elff.

            -
            +

            Site built with pkgdown 2.0.7.

            +

            Using preferably template.

            -
            +
            + diff --git a/reference/services.html b/reference/services.html index 5fc4969..2287344 100644 --- a/reference/services.html +++ b/reference/services.html @@ -1,57 +1,70 @@ -Add or remove services — services • RKernelAdd or remove services — services • RKernel - Skip to contents + -
            -
            -
            -

            Add or remove services

            - -
            services.Rd
            +
            -
            +

            Add or a service to the kernel, i.e. a function that is called in each iteration of the kernel event loop.

            -
            -

            Usage

            + 
            add_service(run, init = NULL)
 
 remove_service(run)
            -
            -

            Arguments

            +
            +

            Arguments

            run

            A function to be run in each loop iteration.

            @@ -61,22 +74,27 @@

            Arguments

            +
            + +
            -
            + diff --git a/reference/sharedHelpServer.html b/reference/sharedHelpServer.html index 5aef51f..0fb518b 100644 --- a/reference/sharedHelpServer.html +++ b/reference/sharedHelpServer.html @@ -1,51 +1,65 @@ -R6 objects that run a help server — sharedHelpServer • RKernel" + ); + } +R6 objects that run a help server — sharedHelpServer • RKernel - Skip to contents + -
            -
            -
            -

            R6 objects that run a help server

            - -
            sharedHelpServer.Rd
            +
            -
            +

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

            -
            -

            Public fields

            +
            +

            Public fields

            port

            Integer, the port number

            @@ -60,8 +74,8 @@

            Public fields -

            Methods

            +
            +

            Methods

            Public methods

            @@ -181,22 +195,27 @@

            Arguments

            +
            + +

            -
            + diff --git a/reference/to_json.html b/reference/to_json.html index 036b5c7..6a1c13c 100644 --- a/reference/to_json.html +++ b/reference/to_json.html @@ -1,50 +1,63 @@ -A Genereric Converter to JSON — to_json • RKernelA Genereric Converter to JSON — to_json • RKernel - Skip to contents + -
            -
            -
            -

            A Genereric Converter to JSON

            - -
            to_json.Rd
            +
            -
            +

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

            -
            -

            Usage

            + 
            to_json(x, auto_unbox = TRUE, ...)
 
 # S3 method for default
@@ -72,8 +85,8 @@ 
            Usage
 to_json(x, ...)
            -
            -

            Arguments

            +
            +

            Arguments

            x

            An object to be converted as JSON

            @@ -87,8 +100,8 @@

            ArgumentstoJSON.

            -
            -

            Methods (by class)

            +
            +

            Methods (by class)

            • to_json(default): Default S3 method

            • to_json(list): S3 method for lists.

              • @@ -101,22 +114,27 @@

              Methods (by class)

            +
            + +
            -
            + diff --git a/reference/tracing_source.html b/reference/tracing_source.html index 019dae1..b948f51 100644 --- a/reference/tracing_source.html +++ b/reference/tracing_source.html @@ -1,76 +1,94 @@ -Step through a scripted being sourced — tracing_source • RKernelStep through a scripted being sourced — tracing_source • RKernel - Skip to contents + -
            -
            -
            -

            Step through a scripted being sourced

            - -
            tracing_source.Rd
            +
            -
            +

            The function parses the contents of a script and evaluates each expression within it step-by-step.

            -
            -

            Usage

            + 
            tracing_source(filename)
            -
            -

            Arguments

            +
            +

            Arguments

            filename

            A string; the name of the script file.

            -
            +
            + +
            -
            +

            Developed by Martin Elff.

            -
            +

            Site built with pkgdown 2.0.7.

            +

            Using preferably template.

            -
            +
            + diff --git a/reference/virtable_widget.html b/reference/virtable_widget.html index 3caa190..efaaedb 100644 --- a/reference/virtable_widget.html +++ b/reference/virtable_widget.html @@ -1,50 +1,63 @@ -Widgets to show tabular data — virtable_widget • RKernelWidgets to show tabular data — virtable_widget • RKernel - Skip to contents + -
            -
            -
            -

            Widgets to show tabular data

            - -
            virtable_widget.Rd
            +
            -
            +

            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)),
@@ -60,8 +73,8 @@ 
            Usage
 fmt_tab_section(x, i, j)
            -
            -

            Arguments

            +
            +

            Arguments

            x

            A tabular object, e.g. a data frame

            @@ -82,30 +95,35 @@

            Arguments -

            Functions

            +
            +

            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): Dibble method

            -

            +
            + +
            -
            +

            Developed by Martin Elff.

            -
            +

            Site built with pkgdown 2.0.7.

            +

            Using preferably template.

            -
            +
            + diff --git a/reference/with.Context.html b/reference/with.Context.html index 0eda57c..1b3df2f 100644 --- a/reference/with.Context.html +++ b/reference/with.Context.html @@ -1,56 +1,69 @@ -Evalute expressions within a context — with.Context • RKernel" + ); + } +Evalute expressions within a context — with.Context • RKernel - Skip to contents + -
            -
            -
            -

            Evalute expressions within a context

            - -
            with.Context.Rd
            +
            -
            +

            A method for the generic function "with" to be used with context objects.

            -
            -

            Usage

            + 
            # S3 method for Context
 with(data, expr, enclos = parent.frame(), ...)
            -
            -

            Arguments

            +
            +

            Arguments

            data

            A Context object

            @@ -68,22 +81,27 @@

            Arguments

            +
            + +
            -
            +