JSL Syntax Reference • JSL Messages • R Integration Messages

For the latest version of JMP Help, visit JMP.com/help.

Previous
 • 
Next
R Integration Messages
The R interfaces are also scriptable using an R connection object. A scriptable R connection object can be obtained using the R Connect() function.
rconn<<Control(Interrupt (1))
If Async is set to true (1) for R Submit(), this message immediately stops the execution of the R code that was submitted.
rconn<<Disconnect()
Disconnects this R connection.
rconn<<Is Connected()
Returns 1if the R connection is active, 0 otherwise.
rconn<<Send("name", named_arguments)
Send the specified JMP variable to R.
Returns
0 if successful, nonzero otherwise.
Argument
name
A quoted string contains the name of a JMP variable to send to R.
Arguments for Data Tables
Selected(0|1)
Optional, Boolean. If true, sends only the selected rows from the referenced data table to R.
Excluded(0|1)
Optional, Boolean. If true, sends only the excluded rows from the referenced data table to R.
Labeled(0|1)
Optional, Boolean. If true, sends only labeled rows from the referenced data table to R.
Hidden(0|1)
Optional, Boolean. If true, sends only hidden rows from the referenced data table to R.
Colored(0|1)
Optional, Boolean. If true, sends only colored rows from the referenced data table to R.
Markered(0|1)
Optional, Boolean. If true, sends only markered rows from the referenced data table to R.
Row States(0|1, <named arguments>)
Optional. Includes a Boolean argument and optional named arguments. Sends row state information from the referenced data table to R by adding an additional data column named “RowState”. The row state value consists of individual settings with the values shown in Table 3.2.
Table 3.2 Row States 
Multiple row states are created by adding together individual settings.
Selected = 1
Excluded = 2
Labeled = 4
Hidden = 8
Colored = 16
Markered = 32
Arguments
Colors(Boolean)
Optional, Boolean. If true, sends row colors and adds an additional data column named “RowStateColor”.
Markers(Boolean)
Optional, Boolean. If true, sends row markers and adds an additional data column named “RowStateMarker”.
rconn<<Send("name")
Send the specified JMP data file to R.
rconn<<Get("name")
Gets the specified variable from R.
Returns
The value of the specified variable.
Arguments
name
A quoted string that contains the name of a JMP variable to be retrieved from R.
rconn<<Get Graphics("type")
Gets the last graphics object written to the R graph display window. The graphics object can be returned in different graphic formats.
Returns
A JMP picture object.
Arguments
type
The format the R graph display window contents are to be converted to. Valid formats are "png", "bmp", "jpeg", "jpg", "tiff", and "tif".
rconn<<Submit("code", named_arguments)
Submits the R code.
Returns
0 if successful, nonzero otherwise.
Arguments
code
A quoted string that contains the R code to submit.
Expand(0|1)
Optional, Boolean. Performs an Eval Insert() on the R code before submitting the code.
Echo(0|1)
Optional, Boolean. Echoes the R source lines to the JMP log. The default value is true.
Rconn<<Submit File("filepath")
Submits statements to R using the file in the "filepath".
Arguments
filepath
A quoted string that contains the pathname to the file that contains R code to be executed.
rconn<<Execute({ list of inputs }, { list of outputs }, "code", named_arguments)
Submits the R code to the R connection using the list of inputs. Upon completion, a list of outputs is returned.
Returns
0 if successful, nonzero otherwise.
Arguments
{ list of inputs }
List of JMP variable names to be sent to R as inputs.
{ list of outputs }
List of JMP variable names to be retrieved from R as outputs.
code
A quoted string that contains the R code to submit.
named_arguments
See rconn<<Submit("code", named_arguments).
rconn<<Control(named_arguments)
Controls the execution of R.
Returns
Void.
Argument
Echo(Boolean)
Optional, Boolean. Echoes the R source lines to the JMP log.
rconn<<Get Version()
Gets the current version of R that is installed.
Returns
A vector of length 3 containing the R version number.
rconn<<JMP Name To R Name("name")
Maps a JMP Name to its corresponding R Name using R variable name naming rules.
Returns
A string that contains the R name.
Arguments
name
A quoted string that contains the name of a JMP variable to be sent to R.

Previous
 • 
Next
Help created on 3/19/2020