HowToInstallRSPerl: Difference between revisions

From BRF-Software
Jump to navigation Jump to search
imported>MichaelDondrup
No edit summary
imported>MichaelDondrup
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
= Short Installation instructions for RSPerl =
= Short Installation Instructions for RSPerl =
 
== NOTE ==
RSPerl -- The Omegahat interface for R and Perl.
 
Follow these instructions to install the RSPerl bidirections interface for use with the EMMA 2 software.
 
The RSPerl software is written and copyrighted by Duncan Temple Lang and distributed under the FreeBSD license.
See the RSPerl homepage:  http://www.omegahat.org/RSPerl/index.html
 
'''Please report any problems related to RSPerl to the omega help mailing list: omega-help@eeyore.ucdavis.edu'''


Follow these instructions to install RSPerl for EMMA.
If you also want to use RSPerl for another purpose (e.g. Perl from R), you should also consider the original installation instructions.
If you also want to use RSPerl for another purpose (e.g. Perl from R), you should also consider the original installation instructions.


'''Please report any problems related to RSPerl to the omega help mailing list: omega-help@eeyore.ucdavis.edu'''
-----
 
<span style="font-size: x-large; color: red">!</span> '''This page is meant for internal use at the CeBiTec. Any information in this document is provided without any warranty.''' <span style="font-size: x-large; color: red">!</span>
 
-----


== Prerequisites ==
== Prerequisites ==


* Perl
* Perl >= 5.8.x
* R  
* R = 2.2.1
 
both installed and working.  
both installed and working.  
R needs to be configured with --enable-r-shared switch (which is the case by default).
 
R needs to be configured with <code><nowiki>--enable-R-shlib</nowiki></code> switch (which is the case by default).


== Obtaining the sources ==
== Obtaining the sources ==


-- [[MichaelDondrup]] [[DateTime(2006-05-22T13:37:36Z)]]
-- [[MichaelDondrup]] [[DateTime(2006-05-22T13:37:36Z)]]
/!\ The current version  (0.8-1) has a bug that prevents EMMA to function with it.
/!\ The current version  (0.8-1) has a bug that prevents EMMA to function with it.


Please use the following patched version (0.8.0.2) until the problem is continously solved:
Please use the following patched version (0.8.0.2) until the problem is finally solved:


[[Media:HowToInstallRSPerl$RSPerl_0.8.0.2.tar.gz| RSPerl_0.8.0.2.tar.gz]]
[[Media:HowToInstallRSPerl$RSPerl_0.8.0.2.tar.gz| RSPerl_0.8.0.2.tar.gz]]


Note that it has been tested only on FreeBSD 5.4 and Solaris 2.9, up to now.
The patched version has been tested with
 
* FreeBSD 5.4
* Solaris 9 and 10 (sparc and i386)
* Ubuntu Linux 5.10 (thanx to Johan Nylander)
* R 2.2.1
* Perl 5.8.x
 
/!\ Build attemps with R 2.3.0 were reported to fail.


(Otherwise, you could:
(Otherwise, you could:
Line 38: Line 62:
</nowiki></pre>
</nowiki></pre>


(replace X with the actual version).
(replace X with the actual version)
or
 
<pre><nowiki>
somebody# R CMD INSTALL -l <whereever> --configure-args='--with-in-perl --with-modules=""' RSPerl_X.tar.gz
</nowiki></pre>
 
to install to another directory.
This is recommended, for a first test of the package, and if you do not want to or cannot become privileged user.
 
== Setting up the Environment ==
 
For RSPerl to execute R commands from within Perl you have to set <code><nowiki>LD_LIBRARY_PATH</nowiki></code>, <code><nowiki>PERL5LIB</nowiki></code>, and <code><nowiki>R_HOME</nowiki></code>.
 
 
<pre><nowiki>
export R_HOME=/usr/local/lib/R
# or wherever you installed it
RSPERLDIR=$R_HOME/library/RSPerl
# or wherever you put RSPerl
 
export LD_LIBRARY_PATH=$RSPERLDIR/libs:$R_HOME/lib
 
export PERL5LIB=$RSPERLDIR/share/lib/site_perl
# check, that this directory contains R.pm and RReferences.pm
</nowiki></pre>
 
 
To avoid having to set <code><nowiki>PERL5LIB</nowiki></code> you could also copy the content of $RSPERLDIR/share/lib/site_perl/ to the
site_perl directory of your local perl installation.
 
== Issues ==
 
* The scripts RSPerl.bsh and RSPerl.csh in the scripts/ subdirectory are currently broken.
* Too many environment variables have to be set.
* The installation process should try to install the .pm files in the standard perl distribution
* No build with R 2.3.0
* <code><nowiki>-c</nowiki></code> or <code><nowiki>--clean</nowiki></code> will not completely clean up the files generated by configure.
* I did not update the CHANGES file in the package.


== System specific issues ==
== System specific issues ==
=== Solaris ===
There is a patch kindly provided by Björn Fischer from the [[CeBiTec]] support group, that will erase the need to set the LD_LIBRARY_PATH.
The patch will appear here soon.


=== FreeBSD ===
=== FreeBSD ===

Revision as of 16:34, 24 May 2006

Short Installation Instructions for RSPerl

NOTE

RSPerl -- The Omegahat interface for R and Perl.

Follow these instructions to install the RSPerl bidirections interface for use with the EMMA 2 software.

The RSPerl software is written and copyrighted by Duncan Temple Lang and distributed under the FreeBSD license. See the RSPerl homepage: http://www.omegahat.org/RSPerl/index.html

Please report any problems related to RSPerl to the omega help mailing list: omega-help@eeyore.ucdavis.edu

If you also want to use RSPerl for another purpose (e.g. Perl from R), you should also consider the original installation instructions.


! This page is meant for internal use at the CeBiTec. Any information in this document is provided without any warranty. !


Prerequisites

  • Perl >= 5.8.x
  • R = 2.2.1

both installed and working.

R needs to be configured with --enable-R-shlib switch (which is the case by default).

Obtaining the sources

-- MichaelDondrup DateTime(2006-05-22T13:37:36Z)

/!\ The current version (0.8-1) has a bug that prevents EMMA to function with it.

Please use the following patched version (0.8.0.2) until the problem is finally solved:

RSPerl_0.8.0.2.tar.gz

The patched version has been tested with

  • FreeBSD 5.4
  • Solaris 9 and 10 (sparc and i386)
  • Ubuntu Linux 5.10 (thanx to Johan Nylander)
  • R 2.2.1
  • Perl 5.8.x

/!\ Build attemps with R 2.3.0 were reported to fail.

(Otherwise, you could: download the latest RSPerl package from http://www.omegahat.org/RSPerl/index.html.)

Installation

You need to be a privileged user to install RSPerl in the standard location of R libraries and Perl modules. At the console, type:


radmin#  R CMD INSTALL --configure-args='--with-in-perl --with-modules=""' RSPerl_X.tar.gz 

(replace X with the actual version) or

somebody# R CMD INSTALL -l <whereever> --configure-args='--with-in-perl --with-modules=""' RSPerl_X.tar.gz 

to install to another directory. This is recommended, for a first test of the package, and if you do not want to or cannot become privileged user.

Setting up the Environment

For RSPerl to execute R commands from within Perl you have to set LD_LIBRARY_PATH, PERL5LIB, and R_HOME.


export R_HOME=/usr/local/lib/R 
# or wherever you installed it
RSPERLDIR=$R_HOME/library/RSPerl 
# or wherever you put RSPerl 

export LD_LIBRARY_PATH=$RSPERLDIR/libs:$R_HOME/lib

export PERL5LIB=$RSPERLDIR/share/lib/site_perl
# check, that this directory contains R.pm and RReferences.pm


To avoid having to set PERL5LIB you could also copy the content of $RSPERLDIR/share/lib/site_perl/ to the site_perl directory of your local perl installation.

Issues

  • The scripts RSPerl.bsh and RSPerl.csh in the scripts/ subdirectory are currently broken.
  • Too many environment variables have to be set.
  • The installation process should try to install the .pm files in the standard perl distribution
  • No build with R 2.3.0
  • -c or --clean will not completely clean up the files generated by configure.
  • I did not update the CHANGES file in the package.

System specific issues

Solaris

There is a patch kindly provided by Björn Fischer from the CeBiTec support group, that will erase the need to set the LD_LIBRARY_PATH. The patch will appear here soon.

FreeBSD

RSPerl uses GNU make features. To be able to install RSPerl on systems, where make is not GNU make by default, do the following prior to running R CMD INSTALL (provided you are using bash):


radmin#  export MAKE=gmake