koInstall {svKomodo}R Documentation

Install and uninstall hooks for communicating with Komodo Edit/IDE

Description

Install functions in SciViews:TempEnv and callbacks required to communicate with Komodo Edit with the SciViews-K extension (see https://github.com/SciViews/sciviewsk).

Usage

koInstall()

koUninstall()

Details

The minimum instruction to install the communication with Komodo/SciViews-K (so called, SciViews Komodo) is to use: ⁠options(ko.serve = 8888); require(svKomodo)⁠. When the ko.serve option is set, svKomodo loads svSocket, starts the socket server listening to the port you have selected (8888 by default), and install the hooks and callbacks required to communicate with SciViews Komodo.

Before loading svKomodo, you can also set option(ko.port = 7052) or another port number where the Komodo SciViews-K server is listening (7052 is the default value). If the Komodo client is running on a different machine, you should also set ko.host = "xxx.xxx.xxx.xxx", where xxx.xxx.xxx.xxx is the IP address of the Komodo client's machine, before loading svKomodo (note that running R and Komodo on separate machines is not supported yet, but this is a planned feature and corresponding configurations are already recognized; just, distant server is currently locked until we will build a better security mechanism in the server (SSL, TSL, ...).

All these operations are done by Komodo if you start R from Komodo with SciViews-K extension installed.

Value

Returns nothing.

See Also

koCmd()


[Package svKomodo version 1.0.0 Index]