How to Use TERR Tools


Spotfire® Enterprise Runtime for R (a/k/a TERR™) is a high-performance statistical engine that is compatible with open-source R. It is provided in your installation of Spotfire so you can script and run data functions or create predictive models. TERR Tools are provided to give you access to the TERR console to test scripts and functions, and to the TERR Language Reference for help with installed packages. You can use TERR Tools to launch the RStudio interactive development environment for script authoring. TERR Tools also provides an interface to download and install packages from the Comprehensive R Archive Network (CRAN).

Note: The TERR Tools option is an extension in Spotfire, so you must have the extension license to use TERR Tools. See your administrator for more information.

To find the Spotfire Enterprise Runtime for R engine:

  1. On the menu bar, click Tools > TERR Tools.

  2. Response: The TERR Tools dialog is displayed.

    Comment: Note that the path to the engine is displayed but is unchangeable in the Path to Local TERR Engine text box.

  3. In the Engine tab, click Copy TERR Engine Path to Clipboard.

  4. Comment: You can use this feature to set the R version to this installation of TERR in the  RStudio Tools > Options dialog.

To display the Spotfire Enterprise Runtime for R console:

  1. On the menu bar, click Tools > TERR Tools.

  2. Response: The TERR Tools dialog is displayed.

  3. Click Launch TERR Console.

  4. Response: The TERR engine console that is included in the Spotfire Modules folder is displayed in a separate window.

To open an instance of RStudio:

  1. On the menu bar, click Tools > TERR Tools.

  2. Response: The TERR Tools dialog is displayed.

  3. Click Launch RStudio IDE.

  4. Response: The RStudio integrated development environment opens in another window.

    Comment: To use this feature, you must have installed the version of RStudio IDE, using the RStudio installer, for the version tested with TERR.

To display help for Spotfire Enterprise Runtime for R:

  1. On the menu bar, click Tools > TERR Tools.

  2. Response: The TERR Tools dialog is displayed.

  3. Click Open TERR Language Reference.

  4. Response: A web browser launches and displays the landing page with links to the documentation for TERR.

    Comment: The language reference is included in the installation. The links to the technical documentation  and readme files open these documents at the documentation site.

To find a package on CRAN:

  1. On the menu bar, click Tools > TERR Tools.

  2. Response: The TERR Tools dialog is displayed.

  3. Click the Package Management tab.

  4. Click the drop-down arrow for the CRAN Package Repository list, select the repository site mirror to use, and then click Load.

  5. Comment: Download speed might be better for repositories located closer to your location.

    Result: CRAN packages available at the location you selected are displayed in the Available Packages selection box.

  6. Scroll through the list to locate the package you need. Alternatively, for a specific package, type its name in the Available Packages box.

  7. Comment: As you type, the list is filtered.  You can select multiple packages by holding down the Shift key (for adjacent selections), or holding down the Ctrl key (for nonadjacent selections) as you select.

  8. Click Install to install the selected packages.

  9. Result: The Installed Packages list is updated to reflect the new installation.

To remove an installed package

  1. On the menu bar, click Tools > TERR Tools.

  2. Response: The TERR Tools dialog is displayed.

  3. Click the Package Management tab.

  4. From the Installed Packages list, select one or more packages to remove, and then click Remove.

  5. Result: The package is removed from your computer and the list is updated.

Note: Spotfire packages (SPKs) differ from TERR and R packages. The SPK is the means to deploy extensions to the Spotfire Server, which then distributes its contents to Spotfire Analyst users.

For more information about sharing TERR and R packages in Spotfire analyses, see the Spotfire Enterprise Runtime for R Technical Documentation available at the documentation site.

See also:

TERR Tools - Details on Engine

TERR Tools - Details on Package Management