ToRForm

ToRForm[expr]
returns a full form of expr used by RLink internally to communicate with R. For expressions that do not correspond to any supported R type and cannot be converted, returns $Failed.

DetailsDetails

  • Null is interpreted as an R NULL element and transformed to RNull[].
  • Scalars of basic vector types (integers, reals, complex numbers, strings, and True|False) are interpreted as one-element R vectors of the same types. This reflects the way they are treated in R.
  • Lists (or multidimensional arrays) of basic vector types (integers, reals, complex numbers, strings, and True|False) are interpreted as R vectors and transformed into expressions with an RVector head.
  • All lists representing R vectors (including multidimensional arrays) can contain missing elements, which must be represented by Missing[].
  • Lists not matching the above description will automatically be interpreted as R lists and converted to expressions with the head RList. That would include ragged lists and lists of elements of different types. Valid (for the purposes of RLink) R lists can contain other valid R lists, valid R vectors, or an R NULL element.
  • Expressions with the heads REnvironment, RCode, or RFunction are left unchanged under the action of , with the exception of the conversion of function attributes that expressions with the head RFunction may contain.
  • Whenever you need to send to R an object with nontrivial attributes, you will need to use the container RObject, which allows you to store both your data and the attributes, and RAttributes, for attributes specifically.
  • All Mathematica expressions that do not fall into one of the above categories cannot be currently sent to R and passing those to will result in $Failed being returned.
  • is called internally by RSet to convert your input into internal RLink representation before sending it to R. Most of the time, you will not need to call this function explicitly. It is, however, useful to determine RLink's internal form of your input, in particular to test whether or not RLink interpreted your input as you intended.

ExamplesExamplesopen allclose all

Basic Examples (6)Basic Examples (6)

In[1]:=
Click for copyable input

Here are some sample conversions for basic vector types:

In[1]:=
Click for copyable input
Out[1]=

NULL is transformed to RNull:

In[2]:=
Click for copyable input
Out[2]=

Here is an internal form of a list of integers:

In[3]:=
Click for copyable input
Out[3]=

A list of reals:

In[4]:=
Click for copyable input
Out[4]=

A list of complex numbers:

In[5]:=
Click for copyable input
Out[5]=
In[6]:=
Click for copyable input
Out[6]=

A list of logical values (True or False):

In[7]:=
Click for copyable input
Out[7]=

A list of strings:

In[8]:=
Click for copyable input
Out[8]=

A list with missing elements:

In[9]:=
Click for copyable input
Out[9]=

However, lists of elements of different types will be interpreted as an R list. For example:

In[1]:=
Click for copyable input
Out[1]=
In[2]:=
Click for copyable input
Out[2]=
In[3]:=
Click for copyable input
Out[3]=

The previous example illustrates that the full internal RLink form is often rather inconvenient to work with.

Here is an internal form of an integer matrix:

In[1]:=
Click for copyable input
Out[1]=
In[2]:=
Click for copyable input
Out[2]=

You can notice three things here: first, matrix data is stored in a one-dimensional list. Second, the matrix is converted to a column-major order, since this corresponds to how it is stored in R. Finally, matrix dimensions are stored in the "dim" attribute.

Ragged (irregular) lists will be interpreted as R lists:

In[1]:=
Click for copyable input
Out[1]=

The same is true for lists containing elements of different types:

In[2]:=
Click for copyable input
Out[2]=

When you have to give your R object some extra attributes, you must wrap what you would normally construct in an RObject head and add attributes wrapped in an RAttributes head:

In[1]:=
Click for copyable input
Out[1]=
In[2]:=
Click for copyable input
Out[2]=

To perform the reverse operation and obtain a short form from the full internal form for a given expression representing some R object, you can use FromRForm:

In[3]:=
Click for copyable input
Out[3]=

The list, which is the value of the "myAtt" attribute for this object, was returned in a slightly different form. This is consistent with scalars being treated by R as one-element vectors, but can become a problem if you always rely on automatic type identification:

In[4]:=
Click for copyable input
Out[4]=
In[5]:=
Click for copyable input
Out[5]=

This problem and the recommended solution are discussed in more detail in the documentation page for RList.

Regardless of the way interprets things, the cycle to FromRForm should always return the same expression, except "dressing" scalars in extra lists.

New to Mathematica? Find your learning path »
Have a question? Ask support »