e_frame: Define an e_frame object

Description Usage Format Fields Methods

Description

Define an e_frame object

Usage

1

Format

An R6Class generator object

Fields

serveraddress

Stores address of your lightning server

sessionid

Stores id of your current session on the server.

url

Stores url of the last visualization created by this object.

autoopen

Checks if the server is automatically opening the visualizations.

notebook

Checks if the server is in the jupyter notebook mode.

Methods

Documentation

For full documentation of each method go to https://github.com/lightning-viz/lightining-r/

new(serveraddress)

This method is used to create object of this class with serveraddress as address of the server object is connecting to.

sethost(serveraddress)

This method changes server that you are contacting with to serveraddress.

createsession(sessionname = "")

This method creates new session on the server with optionally given name in sessionname.

usesession(sessionid)

This method changes currently used session on the server to the one with id given in sessionid parameter.


cvmartin/eflows documentation built on Dec. 1, 2020, 1:30 p.m.