[Subgroup-commits] r56 - in pkg/rsubgroup: . man

[noreply at r-forge.r-project.org]

Author: atzmueller
Date: 2015-04-22 21:01:02 +0200 (Wed, 22 Apr 2015)
New Revision: 56

Modified:
   pkg/rsubgroup/NEWS
   pkg/rsubgroup/man/subgroup-package.Rd
Log:
update/extend description with startup hint.

Modified: pkg/rsubgroup/NEWS
===================================================================
--- pkg/rsubgroup/NEWS	2014-10-13 14:31:43 UTC (rev 55)
+++ pkg/rsubgroup/NEWS	2015-04-22 19:01:02 UTC (rev 56)
@@ -3,7 +3,7 @@
 For a detailed list of changes, see the svn commit history at
 svn://r-forge.r-project.org/svnroot/subgroup/
 
-Changes in version 0.6 (2014-10-dd)
+Changes in version 0.7 (2015-04-xx)
 ===================================
 * Improvements
   * document setting Java heap space before loading the rsubgroup library.

Modified: pkg/rsubgroup/man/subgroup-package.Rd
===================================================================
--- pkg/rsubgroup/man/subgroup-package.Rd	2014-10-13 14:31:43 UTC (rev 55)
+++ pkg/rsubgroup/man/subgroup-package.Rd	2015-04-22 19:01:02 UTC (rev 56)
@@ -8,6 +8,8 @@
 \description{
 The rsubgroup package contains a set of efficient and effective
  tools and algorithms for subgroup discovery and analytics.
+The package integrates an R interface to the org.vikamine.kernel
+library of the VIKAMINE system (http://www.vikamine.org).
 
 Note:
 rsubgroup uses rJava. To set the maximum available heap space for Java, the
@@ -16,6 +18,11 @@
 library(rJava)
 .jinit(parameters="-Xmx2048M") # for two gigabytes heap space, for example
 library(rsubgroup)
+
+Please note that this needs to happen before rJava is used in any way. After
+the JVM has been initialized (and started), setting the heap space has no effect
+any more. Therefore, it is recommended to execute the .jinit(...) command right
+after loading the rJava package. 
 }
 \details{
 \tabular{ll}{