Dependencies
biocep.jar
You need to have the workbench installed on your machine, meaning you need the biocep.jar file to be somewhere you know. Instructions on how to get it and install it can be found on the biocep page. Since the power editor follows the developpment of the workbench closely, I would recommend to build the biocep.jar from source, which can be done by retrieveing the biocep project from r-forge :$ svn checkout svn://svn.r-forge.r-project.org/svnroot/biocepFor this to work you need java (>= 1.5) and ant installed. This should create a file biocep.jar that you can copy wherever you like. On my linux machine, I usually put a copy at "/opt/biocep/biocep.jar"
$ cd biocep
$ ant distrib
java and ant
the plugin is written in java, so you need a JDK (at least 1.5) installed and also ant.R packages
The svTools package (from the sciviews) project contains most of the R side code needed by the plugin. At the time of writing, this package is not on CRAN, so you need to install it (and its dependencies) from r-forge:- svTools :
install.packages("svTools",repos="http://R-Forge.R-project.org")
- operators:
install.packages("operators",repos="http://R-Forge.R-project.org")
- svMisc:
install.packages("svMisc",repos="http://R-Forge.R-project.org")
Retrieve the project from r-forge
You can checkout the biocep-editor project from r-forge by :$ svn checkout svn://svn.r-forge.r-project.org/svnroot/biocep-editorOnce the project is retrieved, you need to edit the file build.properties.sample and rename it build.properties.
$ cd biocep-editor
The most important properties to edit are "biocep.dir" and "install.dir" :
- biocep.dir is the name of the directory where the biocep.jar file is located (/opt/biocep in my settings)
- install.dir is the name of the directory where the Editor plugin will be installed, it will be something like "C:\Documents and Settings\romain\RWorkbench\plugins" on windows and something like "/home/romain/RWorkbench/plugins/Editor" on linux
Two "modes" of installation
Dependent mode
The power editor plugin mainly consists of jedit (and jedit plugins) slightly patched so that it can be used as a view of the workbench instead of a main application. The plugin has been developped so that it can coexist with another installed copy of jedit and share the same set of plugins, this is the dependent mode of install because it depends on an installed copy of jedit. Note however that it will only work with versions of jedit greater or equal to 4.3pre16.The ant targets "installDependent" and "zipDependent" can be used to install or create a zip of the plugin. Since with this mode, we are going to depend on another installed version of jedit, we need to let the plugin know about this version, this is achieved by modifying the file "jedit.properties" with appropriate values of the two properties :
- jedit.home: this is the directory where jedit is installed. A "jedit.jar" file must live in this directory along with directories such as modes and jars. I usually install jedit in the directory "/opt/jedit" on my linux machines and under "C:\Program Files\jEdit" on my windows machines.
- jedit.settings: this is the settings directory of jedit, containing jedit plugins (in the jars directory), user mode files (in the modes) directory, ... on my linux machines, it usually is "/home/romain/.jedit" and on my windows machines "C:\Documents and Settings\romain\.jedit"
$ ant installDependent
Standalone mode
However, you do not need to have jedit installed for the plugin to work at all, if you do not have jedit installed otherwise, you will use the standalone mode of installation of the plugin. In this mode, you do not need to edit the jedit.properties file since a dummy one will be generated by ant, simply build the plugin using the "installStandalone" target:ant installStandalone
Check that the plugin is installed
After succesful installation, the workbench should contain the menu item "Plugins > Editor > Power Editor"![powereditorbutton.png, janv. 2009](/public/posts/post2-install/powereditorbutton_m.jpg)