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

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

Author: atzmueller
Date: 2014-10-13 04:10:29 +0200 (Mon, 13 Oct 2014)
New Revision: 54

Added:
   pkg/rsubgroup/man/SDTaskConfig.Rd
Modified:
   pkg/rsubgroup/DESCRIPTION
   pkg/rsubgroup/NEWS
   pkg/rsubgroup/R/classes.R
   pkg/rsubgroup/R/subgroup.R
   pkg/rsubgroup/man/SDTaskConfig-class.Rd
   pkg/rsubgroup/man/subgroup-package.Rd
Log:
* extended documentation and integrated last changes for passing Rcheck

Modified: pkg/rsubgroup/DESCRIPTION
===================================================================
--- pkg/rsubgroup/DESCRIPTION	2014-10-05 18:54:49 UTC (rev 53)
+++ pkg/rsubgroup/DESCRIPTION	2014-10-13 02:10:29 UTC (rev 54)
@@ -1,8 +1,8 @@
 Package: rsubgroup
 Type: Package
 Title: Subgroup Discovery and Analytics
-Version: 0.6
-Date: 2014-09-10
+Version: 0.7
+Date: 2014-10-13
 Author: Martin Atzmueller
 Maintainer: Martin Atzmueller <martin at atzmueller.net>
 Description: A collection of efficient and effective tools and

Modified: pkg/rsubgroup/NEWS
===================================================================
--- pkg/rsubgroup/NEWS	2014-10-05 18:54:49 UTC (rev 53)
+++ pkg/rsubgroup/NEWS	2014-10-13 02:10:29 UTC (rev 54)
@@ -3,6 +3,15 @@
 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)
+===================================
+* Improvements
+  * document setting Java heap space before loading the rsubgroup library.
+
+* Bug fixes:
+  * fix providing attributes=NULL (i.e., automatically include all attributes)
+  into subgroup discovery
+
 Changes in version 0.6 (2014-09-10)
 ===================================
 * Improvements:

Modified: pkg/rsubgroup/R/classes.R
===================================================================
--- pkg/rsubgroup/R/classes.R	2014-10-05 18:54:49 UTC (rev 53)
+++ pkg/rsubgroup/R/classes.R	2014-10-13 02:10:29 UTC (rev 54)
@@ -28,7 +28,7 @@
   return(.jarray(attributeIDs))
 }
 
-setClassUnion("vectorOrNull",members=c("vector", "NULL"))
+setClassUnion(".vectorOrNull", members=c("vector", "NULL"))
 
 setClass("SDTaskConfig",
     representation(
@@ -41,7 +41,7 @@
         nodefaults  = "logical",
         relfilter   = "logical",
         postfilter  = "character",
-        attributes  = "vectorOrNull"
+        attributes  = ".vectorOrNull"
     ),
     prototype(qf="ps", method="sdmap", k = as.integer(20), minqual = as.integer(0), minsize = as.integer(0),
         maxlen = as.integer(7), nodefaults = FALSE, relfilter = FALSE, postfilter = "", attributes = NULL)

Modified: pkg/rsubgroup/R/subgroup.R
===================================================================
--- pkg/rsubgroup/R/subgroup.R	2014-10-05 18:54:49 UTC (rev 53)
+++ pkg/rsubgroup/R/subgroup.R	2014-10-13 02:10:29 UTC (rev 54)
@@ -76,13 +76,13 @@
   return(simpleTask)
 }
 
-CreateSDTask <- function(source, target, config = new("SDTaskConfig")) {
+CreateSDTask <- function(source, target, config = SDTaskConfig()) {
   # Creates a subgroup discovery task
   #
   # Args:
   #   source: A data source, i.e., dataframe or file (name)
   #   target: The target variable
-  #   config: A SDTaskConfig
+  #   config: A SDTaskConfig task configuration
   #
   # Returns:
   #   A subgroup discovery task
@@ -191,7 +191,7 @@
   }
 }
 
-DiscoverSubgroups <- function(source, target, config=new("SDTaskConfig"), as.df=FALSE) {
+DiscoverSubgroups <- function(source, target, config=SDTaskConfig(), as.df=FALSE) {
   # Performs subgroup discovery according to target and config on data
   #
   # Args:

Modified: pkg/rsubgroup/man/SDTaskConfig-class.Rd
===================================================================
--- pkg/rsubgroup/man/SDTaskConfig-class.Rd	2014-10-05 18:54:49 UTC (rev 53)
+++ pkg/rsubgroup/man/SDTaskConfig-class.Rd	2014-10-13 02:10:29 UTC (rev 54)
@@ -1,7 +1,6 @@
 \name{SDTaskConfig-class}
 \docType{class}
 \alias{SDTaskConfig-class}
-\alias{SDTaskConfig}
 
 \title{Class ``SDTaskConfig'' --- A Set of Configuration
 	Settings}	

Added: pkg/rsubgroup/man/SDTaskConfig.Rd
===================================================================
--- pkg/rsubgroup/man/SDTaskConfig.Rd	                        (rev 0)
+++ pkg/rsubgroup/man/SDTaskConfig.Rd	2014-10-13 02:10:29 UTC (rev 54)
@@ -0,0 +1,8 @@
+\name{SDTaskConfig}
+\alias{SDTaskConfig}
+\title{Creates a Subgroup Discovery Task Configuration}
+\description{
+Creates a subgroup discovery task configuration, that is, an instance of
+SDTaskConfig.
+}
+\keyword{subgroup discovery task configuration}
\ No newline at end of file

Modified: pkg/rsubgroup/man/subgroup-package.Rd
===================================================================
--- pkg/rsubgroup/man/subgroup-package.Rd	2014-10-05 18:54:49 UTC (rev 53)
+++ pkg/rsubgroup/man/subgroup-package.Rd	2014-10-13 02:10:29 UTC (rev 54)
@@ -8,13 +8,21 @@
 \description{
 The rsubgroup package contains a set of efficient and effective
  tools and algorithms for subgroup discovery and analytics.
+
+Note:
+rsubgroup uses rJava. To set the maximum available heap space for Java, the
+.jinit command of rJava needs to be called before loading rsubgroup, i.e.
+
+library(rJava)
+.jinit(parameters="-Xmx2048M") # for two gigabytes heap space, for example
+library(rsubgroup)
 }
 \details{
 \tabular{ll}{
 Package: \tab rsubgroup\cr
 Type: \tab Package\cr
-Version: \tab 0.6\cr
-Date: \tab 2014-09-10\cr
+Version: \tab 0.7\cr
+Date: \tab 2014-10-13\cr
 License: \tab GPL (>= 3)\cr
 LazyLoad: \tab yes\cr
 }