Spotfire® Enterprise Runtime for R

TERR_Integer

In the Spotfire Custom Expressions dialog box, you can select the pre-defined expression TERR_Integer from the Function list. This expression function invokes the TERR engine to return a vector or a single column data frame of the data type integer , which is converted to a Spotfire column of the corresponding Spotfire data type Integer.

The expression function has at least two arguments.
Argument Argument description
A TERR script. The TERR script contains the following.
  • A number of variables using the naming convention that Spotfire requires: input1 to inputN, where inputN is the highest number of the specified inputs, numbered sequentally.
  • A TERR assignment operator (<-) that assigns the results of the TERR evaluation to an object named output (also using the naming convention that Spotfire requires).
Spotfire column names. Passed as additional arguments, these are the data column names that input1 to inputN represent. All columns must be the same length.
The output type is returned from TERR and converted by Spotfire.
Returned by TERR Converted in Spotfire
A vector or a single column data frame of data type integer. A column with the same number of rows as the input, and of the data type Integer.

TERR_Integer example

This example data set gives information on the makes of cars taken from the April, 1990 issue of Consumer Reports (pages 235-255). This data set contains 6 columns for 61 cars (rows). You can find the sample data set in Car data set for Spotfire examples.
Tip: You can copy (CTRL+C) the contents of the sample data table and paste it (CTRL+V) into the Spotfire user interface.
In the expression function, multiply the columns Disp. and Mileage to create a new column.
TERR_Integer("output <- as.integer(input1*input2)",[Disp.],[Mileage])
Note: In the case where the output from the calculation might not be an integer, cast them as an integer by wrapping the expression in the TERR function as.integer.

The resulting table in Spotfire shows the following.


TERR_Integer

Important: Spotfire autocorrects the function case or name to that of built-in Spotfire function names. (For example, TERR contains the function max, and Spotfire contains the function Max. ) You must overwrite this autocorrection manually to ensure that you use the TERR function case and name in your expression function.

See Embedding the Contents of a Script in an Expression Function for a detailed procedure for creating an expression function.