An R package allowing access to Capsis through J4R
The RCapsis package is a light client that relies on the J4R package to connect to a local version of CAPSIS. It provides functions to instantiate a C4Script instances.
Java 8 must be installed. If not, please visit www.java.com/en/download Ideally, it should be the default Java on the Operating System. Should it not be the case, it is then possible to set the path to Java 8 using the J4R package. See below.
A CAPSIS release must be installed prior to using this package. This release does come with this package. A few releases are available on the following googledrive:
Please visit capsis.cirad.fr or reach out to a member of the CAPSIS community to get a release that suits your needs.
The RCapsis package is released under a Lesser General Public License version 3.0 (LGPL 3.0). It comes with absolutely no warranty with the expectation that it will be useful. The details of the LGPL-3.0 can be found at www.gnu.org/licenses/lgpl-3.0.en.html .
The source code is available on GitHub at github.com/CWFC-CCFB/RCapsis.
Any bug or suggestion can be logged as a issue on the project website at github.com/CWFC-CCFB/RCapsis/issues.
The RCapsis package depends on the J4R package. To make it work you will have to go through the following steps:
1- Install the J4R package by copying this line of code in your R console:
install.packages("https://sourceforge.net/projects/repiceasource/files/latest", repos = NULL, type="source")
2- Then download and install the RCapsis package by copying this line of code in your R console:
install.packages("https://sourceforge.net/projects/rcapsis.capsisbridge.p/files/latest", repos = NULL, type="source")
After installing a CAPSIS release and the RCapsis package, a C4Script instance can be created as follows
require(RCapsis)
java8path <- file.path("C:", "Program Files", "Java", "jdk1.8.0_321", "jre", "bin", "java.exe")
setJavaPath(java8path)
myCapsisPath <- file.path("C:","Users", "matforti", "Documents", "7_Developpement", "JavaProjects", "capsis")
setCapsisPath(myCapsisPath)
getCapsisPath()
connectToCapsis()
myScript <- createC4ScriptInstance("artemis") # create a reference to Java C4Script instance in the Java environment
The myScript object is a reference to a C4Script instance on the Java end. All the public methods of this class can be accessed through the myScript object.
The call to the setJavaPath function is only required if Java 8 is NOT the default version on your OS. To know the default version, you can open a command line and type
java -version
It is good practice to shutdown CAPSIS before shutting down the R session. This can be done through the following line of code:
shutdownCapsis()