Learn R Programming

ShinyLight

A lightweight server for R calculations.

This project was funded by the Natural Environment Research Council (grant number 09 NE/T001518/1 ("Beyond Isoplot")).

Building ShinyLight

To rebuild documentation and reinstall the local version of ShinyLight:

./build.sh

Run tests

npm test

or

npm test -- --fgrep 'test that I want' --browser=chrome

Run CRAN checks

./build.sh
_R CMD build .
_R_CHECK_FORCE_SUGGESTS_=true _R_CHECK_CRAN_INCOMING_USE_ASPELL_=true R CMD check --as-cran shinylight_<VERSION>.tar.gz

Copy Link

Version

Install

install.packages('shinylight')

Monthly Downloads

704

Version

1.1.2

License

GPL-3

Maintainer

Tim Band

Last Published

November 30th, 2022

Functions in shinylight (1.1.2)

shinylight.initialize

JavaScript function

Sends a progress update to the client.

shinylight.passToOther

JavaScript function

shinylight.setGridResult

JavaScript function

shinylight.runR

JavaScript function: Runs an R function.

shinylight.setElementJson

JavaScript function

shinylight.setElementPlot

JavaScript function: Sets an <img> element to display a plot returned by runR.

shinylight.makeTable

JavaScript function

shinylight.setElementText

JavaScript function

shinylight.call

JavaScript function

shinylight.setGridResultWithNamedRows

JavaScript function

Start a ShinyLight server which runs R that it is sent

toolkit.HTMLControlElement

JavaScript class

toolkit.HTMLPositionedElement

JavaScript class: A monkey-patched HTMLElement with some extra methods.

JavaScript function: Returns a button.

JavaScript function

toolkit.leftSideBar

JavaScript function: A panel with a side bar.

JavaScript function: A panel with a smaller footer.

JavaScript function: Dereferences an object or array through multiple indices.

toolkit.paramBoolean

JavaScript function: Returns a checkbox input Toolkit Control.

toolkit.loadFileButton

JavaScript function: Returns a button that uploads a file from the client.

toolkit.paramFloat

JavaScript function: Returns a floating point input Toolkit Control.

toolkit.paramColor

JavaScript function: Returns a colour input Toolkit Control.

JavaScript function: Returns a Positioned Element for displaying controls in tabbed pages.

Stops a ShinyLight GUI

Start a ShinyLight server

toolkit.progressBar

JavaScript function: Returns a Positioned Element progress bar.

JavaScript function: A panel with a smaller header.

toolkit.verticalDivide

JavaScript function: Left/right panels with a draggable divider.

toolkit.paramInteger

JavaScript function: Returns an integer input Toolkit Control.

toolkit.paramSelector

JavaScript function: Returns a custom selection box Toolkit Control.

toolkit.rightSideBar

JavaScript function: A panel with a side bar.

toolkit.withTimeout

JavaScript function: Adds a fake callback argument to a nullary function.

toolkit.forEach

JavaScript function

toolkit.groupTitle

JavaScript function: Option group title

toolkit.HTMLContainerElement

JavaScript class: A monkey-patched HTMLElement.

toolkit.HTMLControlContainerElement

JavaScript class

toolkit.makeLabel

JavaScript function: Makes a label suitable for labelling a control.

JavaScript function

toolkit.setAsBody

JavaScript function: Replaces the <main> tag in the document with this element.

toolkit.scrollingWrapper

JavaScript function: Returns a Positioned Element just containing one element.

JavaScript function: Finds if a predicate is true for any member of an array or object.

JavaScript function: Finds if a predicate is true for all members of an array or object.

toolkit.optionsPage

JavaScript function: Returns a Container Element for displaying controls vertically.

toolkit.paramText

JavaScript function: Returns a text input Toolkit Control.

toolkit.overlay

JavaScript function: A panel with an overlay.

toolkit.nonScrollingWrapper

JavaScript function: Returns a Positioned Element just containing one element.

JavaScript function: Returns a Container Element for displaying controls vertically.

toolkit.staticText

JavaScript function: A static text Toolkit Control.

toolkit.whenQuiet

JavaScript function: Transforms a function that should not be called too often into a function that can be called as often as you like.

toolkit.preformattedText

JavaScript function: A static text Toolkit Control in a preformatted style.

Encodes a data frame as a CSV file to be downloaded

Obtains the address that the server is listening on

Opens a browser to look at the server

Sends informational text to the client.

Returns a function that runs an R command

Get index.html with (potentially) the JSON data in `text` inserted.

Renders a plot as a base64-encoded image

framework.shinylightFrameworkStart

JavaScript function: Starts the Shinylight Framework, if you want to use it.

Makes and starts a server for serving R calculations

Renders a plot as a base64-encoded PNG