The R bridge connects Zorro scripts to the R environment and allows R computations from your C code.
R is an interactive script language for data analysis and charting, developed in 1996 by Ross Ihaka and Robert Gentleman of Oakland University as successor to the S language. The latter was developed by John M. Chambers and his colleagues in the Bell Labs company in 1976. Today, R is still being improved by the R Development Core Team including John Chambers. Although R is an interpreted language and thus slow compared to 'real' programming languages such as C, it has many advantages:
- It is the global standard for statistical research, data analysis, and machine learning algorithms.
- It is interactive and easy to use once you're familiar with its command syntax. R functions are short and effective.
- It is 'Zorro-like' - it has a minimalistic user interface and can be easily automatized for experiments and research tasks.
- It has ready-to-use extensions - "packages" - for all imaginable mathematical and statistical tasks, including support vector machines, genetic optimization, several kinds of neural networks, and deep learning algorithms. Meanwhile there are more than 4000 R packages.
- It is continuously developed and supported by the global scientific community. The time between
a research publication and its implementation in a R package is usually very short. In average, 15 new R packages come out every day.
- It is free. As Linus Torvalds said: "Software is like sex - it's better when it's free".
For any imaginable algorithm there's normally already one or several R
packages available. This makes R an excellent tool for financial research or analyzing financial time series, using the newest published methods. However, R is not a
'clean' programming language such as C - it is full of traps to the beginner, so using it effectively needs
some experience. It's also not suited for trading (although some packages provide rudimentary backtest, optimization, and even broker connection functions!). The solution to this is the R bridge that allows
including R computations in a Zorro strategy and using their results for trade signals. The lite-C script
can start R sessions, send price data or indicator values to it, and call training and predicting functions from R machine learning packages. The bridge uses the
R.dll by Bernd Kreuss. Its original distribution with source code is contained in the Zorro\Source folder.
Many problems can be solved in lite-C as well as in R, but R often has already a dedicated command implemented for that. For instance, downloading
and converting historical price data from an online source requires about 10 code lines in lite-C (here), but
often only a single line in R (read.csv("http://ichart.finance.yahoo.com/table.csv?...")).
Installation and test
- Install R from http://cran.r-project.org.
- Open Zorro.ini and make sure that the entry RTermPath contains the correct path to the R terminal RTerm.exe.
- Start Zorro and select the script RTest. Click [Test] for running RTest. If everything went well, you should see
a result in your Zorro window, like this:
- For using the R bridge in your scripts, include the r.h header at the begin of the script.
R bridge functions
The r.h header defines several functions to directly assign and read data types without the need for manually formatting and
executing snippets of R code for these purposes. Not all possible
data types are directly supported, the main emphasis is on vectors and matrices containing
floating point values. Once you have transferred the bulk of
your data as vectors or matrices into the R session, you can execute
snippets of R code to combine them or convert them into something
more complex if needed.
Normally you want to get huge amounts of numeric data into the R session quickly, but not the other way. The assumption is that you want to feed it with price data on order to
crunch numbers, and only need to get back a single value or a vector
as a result.
All vector functions have a parameter for the number of elements. Be careful
that the array you supply has the correct size, or it will crash the R console. Expressions or code snippets have a maximum size of 1000 characters per command; larger pieces of code must be sent with several commands or - much better - be called as a function in the R environment. See RTest.c for example usage.
Rstart(string Filename, int debuglevel): int
Start a new R session, and load R functions and variables from the file
Filename in the Strategy folder.
This must be called in the INITRUN before any R computations can be done. Returns 0 when the R session could not be started, otherwise nonzero.
The R session will stay alive until the end of the simulation or Zorro
Name of a .r file in the Strategy folder containing all needed R functions and variables (f.i. "MySource.r"), or "" (default) for not sourcing a file.
0 - only output fatal errors (default)
1 - output warnings and notes
2 - output every R message
The R output goes to the system debug monitor. Use the free DebugView tool from Microsoft, or call Rx(..., 3) to view R output).
Return 1 if the R session is ready for input, 2 if the session is busy with a computation, and 0 if the session is terminated. R will terminate on any fatal error in the code. You should check this regularly. The last command prior to the termination will be found in the debug output. If R is not running anymore, the R bridge won't emit any more messages and will silently ignore all commands.
Rx(string code, int mode): int
Execute a line of R code. Similar to the Ri / Rd / Rv functions below, as evaluating an expression is also just executing code; the difference is that Rx() can send commands asynchronously, allows R and Zorro to do computations in parallel, and prints R output to the Zorro window.
||R code line to be executed (1000 characters max).
0 - synchronous. Wait until the computation was finished (default).
1 - asynchronous. Return immediately. Rrun() can be used to check when the next R command can be sent.
2 - asynchronous, with a wait loop. Return 1 when finished, or quit with returning 0 when the session was aborted due hitting [Stop] or due to a fatal R error.
3 - asynchronous with a wait loop, and direct R print output to the Zorro window. The debuglevel must be set accordingly.
Rset(string name, int n)
Rset(string name, var d)
Rset(string name, var *v, int elements)
Rset(string name, var *m, int rows, int cols)
Rset(string name, string s)
Store an int, var, series, matrix, or string in the R variable name.
Since the target type depends on whether the variable is int,
var, or a pointer, make sure to use the correct type especially
when storing constants, and typecast it with (int) or
(var) if in doubt.
||Name of the R variable.
||int value to be assigned to a R integer variable.
||var value to be assigned to a R floating point variable.
||Pointer of the var array or series to be assigned to a R vector.
||Pointer of the var array to be assigned to a R matrix, by row order.
||Length of the vector or series. Make sure to give the exact number of elements.
||Number of rows and columns of the matrix.
Ri(string expression): int
Rd(string expression): var
Rv(string expression, var *v, int elements)
Evaluate the given R expression, and return the result as an int, double, or vector. The expression can be a single variable, a R function, or any R code that will evaluate to the required variable type.
||R expression to be evaluated (1000 characters max).
||Pointer of the var array to be filled with the R vector.
||Number of elements of the vector; must be identical in the R code and in the lite-C script.
- Test your R commands and functions carefully on the R console before executing them in a lite-C script. A command error - wrong syntax, a wrong path, a missing R package, or a bad parameter for a R function - will cause the session to abort and all subsequent R commands to fail. You'll normally see the error reason printed in the Zorro window. Use the Rrun() function at the end of every bar of a strategy to determine if the session is still running. When live trading, stop the strategy and raise the alarm when Rrun() fails.
- For checking the R output while under lite-C control, print it to a file, f.i. with the sink function. sink("C:/Project/Trading/Log/RTest.txt") prints all subsequent R output to the given file.
- While the R bridge is busy, Zorro can't react on user actions such as clicking the [Stop] button. For avoiding this on long R computations, use Rx() with mode=2. Alternatively, call Rx() with mode=1 and check Rrun() in a wait() loop (f.i. while(Rrun() == 2) wait(100) ).
- Make sure to send complete commands. If a R command is incomplete f.i. due to a missing bracket at the end, the R session will freeze and consequently Zorro will also freeze.
- If you have the choice, perform script-based computations on the lite-C side, as lite-C is up to 200 times faster than R. Loops in R are awfully slow. However R is preferable for vector and matrix operations.
- R functions usually expect time series in straight order with newest elements last. Use the rev function for reversing the order of a series.
- When passing file names to R, use forward slashes for directories, f.i. "C:/Project/Trading/R/Data.csv". You can use the slash helper function in r.h for converting backslashes to forward slashes (f.i. slash(ZorroFolder)).
- Use [Train] mode and WFO for training machine learning algorithms, f.i. a SVM or neural network. Send training data to R at the end of every WFO cycle, and store the trained models in files for later use in the [Test] or [Trade] session. The advise(NEURAL) function contains a framework for that.
- Install all needed R packages before starting the script. Often-used packages for financial computations are caret, zoo, xts, ttr, quantmod, rminer. There are also several popular packages for machine learning. The e1071 package contains a support vector machine, and the deepnet package contains several deep learning network algorithms, such as sparse autoencoders and Boltzman machines. If the package of a called R function is not installed, the R session will abort with an error message.
- For conveniently working with R, we recommend the free programming environment RStudio (http://www.rstudio.org) that contains a simple debugger.
- The R lectures by Harry Georgakopoulos have been included in this manual. There are also several e-books about R (f.i. R in a nutshell). Scanning through a R book or tutorial
is highly recommended, as it takes a while to get used to the R language. Variables are generated by assignment, and need not be declared. The most common variables are a numeric (= var, int, bool), a vector (= series, array), a matrix (= two-dimensional array), a data frame (= array of structs), and a list (= arbitrary collection of data). A series element can be accessed by appending [n] just as in lite-C, but in R the index begins with 1, not with 0. List elements are indexed with double brackets [[n]]. Although R also recognizes the '=' assignment operator, R assignments are usually made with '<-' or '->' depending on the assignment direction. Functions can write into global variables with '<<-'. Boolean operators are similar to C, but mind the difference between '&' and '&&': the former operates on all vector elements, the latter only on the first - a common trap for C programmers who write their first R code.
- An introduction to exchanging data between Zorro and R can be found on
Examples (see also advise):
// do some R calculations
Rstart("",2); // enable output
for(i=0; i<5; i++)
vecIn[i] = i;
Rset("rin",vecIn,5); // set up a vector
Rx("rout <- rin * 10"); // perform some arithmetics
Rx("print(rout)",3); // print rout to the Zorro window
Rv("rout",vecOut,5); // read it back
printf("Error - R session aborted!");
for(i=0; i<5; i++)
//Example for computing trade signals in R
int Size = 200; // number of candles needed by the R algorithm
quit("R session aborted!");
BarPeriod = 60;
LookBack = Size;
// load all required R objects from a file in the Zorro Data folder
// make sure everything loaded ok
// generate reverse price series (latest price comes last)
vars O = rev(series(priceOpen())),
H = rev(series(priceHigh())),
L = rev(series(priceLow())),
C = rev(series(priceClose()));
// send the last 200 candles to R
// let R compute the signal
var Signal = Rd("Compute(Open,High,Low,Close)");
if(Signal > 0 && !NumOpenLong)
if(Signal < 0 && !NumOpenShort)
// export historical price data to R
string name = "Data\\Export.csv";
BarPeriod = 60;
StartDate = 20140101;
if(is(INITRUN)) // write the header
file_write(name,"Date, Open, High, Low, Close",0);
"\n%04i-%02i-%02i %02i:%02i, %.5f, %.5f, %.5f, %.5f",
/* in R:
> Data <- read.csv('C:/Projects/Zorro/Data/export.csv') # mind the forward slashes
Code conversion, DLL interface, advise