Documentation:WeBWorK/The WeBWorKiR Project: Integrating WeBWorK with R/Installation Guide

From UBC Wiki
Jump to navigation Jump to search

WeBWorKiR Installation Guide

The audience for this guide are system administrators who want to set up R integration in WeBWorK. We assume that you already have, or know how to set up, a basic WeBWorK server. If not, please see the release notes on the WeBWorK wiki and the guide to installing WeBWorK on an Ubuntu server. You may also find Jason Aubrey's ww_install installation script useful.


After you have a working WeBWorK server, there are three distinct steps that need to happen:

  1. set up the R server
  2. install the Perl module for the Perl-R bridge
  3. configure WeBWorK to use this module in PG

Set up the R server

Your R server (which can be on the same server as WeBWorK, but in a real-world scenario will more likely run on its own hardware/VM), is quite easy to set up:

  1. install R following OS-specific instructions on the project homepage.
  2. install the Rserve server, which allows remote clients to execute R code on the Rserve's server and returns the execution's result in response. The easiest way is to run (as an administrative user) Rscript -e 'install.packages("Rserve", repo="")'. Note that this package includes a C source that needs to be compiled, so you have to have the basic developer tools present on the server.
  3. run the Rserve service as appropriate to your system. The command you need to run is "R CMD Rserve". This will start the Rserve daemon which will listen on port 6311. The daemon only accepts connections from the localhost; if you run WebWork and Rserve on separate servers, read the final section of this page for additional configuration steps for your system.

Install the Perl-R bridge

Perl module Statistics::R::IO implements Rserve's communication protocol in Perl and provides translation from R data structures to Perl's. It is available on CPAN and can be installed in the standard manner for Perl modules, e.g., by running (as an admin user) cpan Statistics::R::IO.

Configure Webwork to use the Perl-R bridge in PG

Once the Perl module RserveClient is installed, you can make its functionality available in webwork problems by installing the macro and adding the module to the list of modules preloaded by WeBWorK. We use "${WW_PREFIX}" to indicate the directory where WeBWorK is installed. (This directory will, for instance, contain subdirectories "webwork2" and "pg"; a typical choice is "/opt/webwork", but a different one may be used on your system.)

  1. No need to install as it is included in the official OPL.

    install macro into "$WW_PREFIX/pg/macros":

    wget -q -O ${WW_PREFIX}/pg/macros/ \

    perhaps a better solution, but depending on having the Perl module File::ShareDir, ensures that the macro matches the version of Statistics::R::IO that you have installed:

    cp "`perl -MFile::ShareDir -e 'print File::ShareDir::dist_file(\"Statistics-R-IO\", \"WebWork/\")'`" \
  2. add the RserveClient module(s) to the list of modules preloaded by WeBWorK, so that it is available to the macro. You can do this by modifying "${WW_PREFIX}/webwork2/conf/defaults.conf", but since it's a local configuration, you should put it in localOverrides.conf:

    cat >> ${WW_PREFIX}/webwork2/conf/localOverrides.conf <<'EOF'
    push @{$pg{modules}},
       [qw( Statistics::R::IO::Rserve )],
       [qw( Statistics::R::IO::ParserState )],
       [qw( Statistics::R::REXP::Character )],
       [qw( Statistics::R::REXP::Double )],
       [qw( Statistics::R::REXP::Environment )],
       [qw( Statistics::R::REXP::GlobalEnvironment )],
       [qw( Statistics::R::REXP::Integer )],
       [qw( Statistics::R::REXP::Language )],
       [qw( Statistics::R::REXP::List )],
       [qw( Statistics::R::REXP::Logical )],
       [qw( Statistics::R::REXP::Null )],
       [qw( Statistics::R::REXP::Raw )],
       [qw( Statistics::R::REXP::Symbol )],
       [qw( Statistics::R::REXP::Unknown )],
       [qw( Statistics::R::REXP::Vector )],
       [qw( Statistics::R::REXP )],
       [qw( IO::File )],
       [qw( IO::Handle )];
    $pg{specialPGEnvironmentVars}{Rserve} = {host => "localhost"};
  3. Before is merged into master,
    [qw(Rserve Class::Tiny IO::Handle)]
    has to be added for using the latest version of Statistics-R-IO package.

Additional configuration when WeBWorK and R are on separate hosts

If you run WeBWorK and R on separate hosts, you can either set up a tunnel to forward port 6311 from WeBWorK to R's host, or do the following:

  1. set up Rserve to listen on all network interfaces, not just localhost by adding a line "remote enable" to file "/etc/Rserv.conf":

    cat <'EOF' >> /etc/Rserv.conf
    remote enable
  2. use the correct host name (instead of "localhost") in the "Rserve host" line of "localOverrides.conf". For example:

    $pg{specialPGEnvironmentVars}{Rserve} = {host => ""};

Note that in this case you will also want to set up the Rserve host's firewall to only allow connections from the WeBWorK host(s), or otherwise it will happily execute arbitrary code from any Rserve client anywhere on the internet!