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

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

Author: atzmueller
Date: 2020-04-20 09:35:52 +0200 (Mon, 20 Apr 2020)
New Revision: 69

Modified:
   pkg/rsubgroup/DESCRIPTION
   pkg/rsubgroup/NEWS
   pkg/rsubgroup/man/CreateSDTask.Rd
   pkg/rsubgroup/man/DiscoverSubgroups.Rd
   pkg/rsubgroup/man/SDTaskConfig-class.Rd
Log:


Modified: pkg/rsubgroup/DESCRIPTION
===================================================================
--- pkg/rsubgroup/DESCRIPTION	2020-03-15 21:42:07 UTC (rev 68)
+++ pkg/rsubgroup/DESCRIPTION	2020-04-20 07:35:52 UTC (rev 69)
@@ -1,8 +1,8 @@
 Package: rsubgroup
 Type: Package
 Title: Subgroup Discovery and Analytics
-Version: 0.9
-Date: 2020-03-04
+Version: 1.0
+Date: 2020-04-20
 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	2020-03-15 21:42:07 UTC (rev 68)
+++ pkg/rsubgroup/NEWS	2020-04-20 07:35:52 UTC (rev 69)
@@ -3,6 +3,12 @@
 For a detailed list of changes, see the svn commit history at
 svn://r-forge.r-project.org/svnroot/subgroup/
 
+Changes in version 1.0 (2020-04-20)
+===================================
+* internal enhancements in subgroup.jar, i.e., the VIKAMINE kernel library,
+  e.g. according to better error messages relating to the R connection.
+* Improved documentation and examples.
+
 Changes in version 0.9 (2020-03-04)
 ===================================
 * internal enhancements in subgroup.jar, i.e., the VIKAMINE kernel library

Modified: pkg/rsubgroup/man/CreateSDTask.Rd
===================================================================
--- pkg/rsubgroup/man/CreateSDTask.Rd	2020-03-15 21:42:07 UTC (rev 68)
+++ pkg/rsubgroup/man/CreateSDTask.Rd	2020-04-20 07:35:52 UTC (rev 69)
@@ -9,7 +9,10 @@
 }
 \arguments{
 \item{source}{a data.frame or the a character string giving
-the filename of an ARFF file to use.}
+the filename of an ARFF file to use. Providing a file name
+directly provides the data to the subgroup discovery
+algorithms on the Java side, which is more memory efficient
+than converting the data frame to the Java representation.}
 \item{target}{the target variable (constructed by as.target)
 to consider for subgroup discovery.}
 \item{config}{an instance of SDTaskConfig providing various

Modified: pkg/rsubgroup/man/DiscoverSubgroups.Rd
===================================================================
--- pkg/rsubgroup/man/DiscoverSubgroups.Rd	2020-03-15 21:42:07 UTC (rev 68)
+++ pkg/rsubgroup/man/DiscoverSubgroups.Rd	2020-04-20 07:35:52 UTC (rev 69)
@@ -10,7 +10,10 @@
 }
 \arguments{
 \item{source}{a data.frame or the a character string giving
-the filename of an ARFF file to use.}
+the filename of an ARFF file to use. Providing a file name
+directly provides the data to the subgroup discovery
+algorithms on the Java side, which is more memory efficient
+than converting the data frame to the Java representation.}
 \item{target}{the target variable (constructed by as.target)
 to consider for subgroup discovery.}
 \item{config}{an instance of SDTaskConfig providing various

Modified: pkg/rsubgroup/man/SDTaskConfig-class.Rd
===================================================================
--- pkg/rsubgroup/man/SDTaskConfig-class.Rd	2020-03-15 21:42:07 UTC (rev 68)
+++ pkg/rsubgroup/man/SDTaskConfig-class.Rd	2020-04-20 07:35:52 UTC (rev 69)
@@ -36,17 +36,20 @@
 	The default is \code{qf = "ps"}.
 	}    
     \item{\code{k}:}{The maximum number (top-k) of patterns
-	to discover. The default is \code{k = 20}}
+	to discover, i.e., the best k rules according to the selected
+	quality function. The default is \code{k = 20}}
 	\item{\code{minqual}:}{The minimal quality (default \code{minqual = 0}).}
-	\item{\code{minsize}:}{The minimal size of a subgroup
+	\item{\code{minsize}:}{The minimal size of a subgroup (as an integer)
 	(minimal coverage of database records, default \code{minsize = 0}).}
-	\item{\code{mintp}:}{The minimal true positive (tp) threshold
+	\item{\code{mintp}:}{The minimal true positive (tp) threshold, an integer
 	(minimal (absolute) number of true positives in a subgroup, relevant for
 	binary target concepts only), defaults to \code{mintp = 0}}.
-	\item{\code{maxlen}:}{The maximal description length of
-	a pattern, i.e., the maximal number of conjunctions (default \code{maxlen = 7}).}
+	\item{\code{maxlen}:}{The maximal length of a description of
+	a pattern, i.e., the maximal number of conjunctions. This impacts both
+	understandability and efficiency. Simpler rules are easier to understand,
+	and a small \code{maxlen} will restrict the search space (default \code{maxlen = 7}).}
 	\item{\code{nodefaults}:}{Ignore default values, i.e.,
-	do not include the respective first value of each
+	do not include the respective first value (with index 0) of each
 	attribute (default \code{nodefaults=FALSE}, i.e., include all values).}
 	\item{\code{relfilter}:}{Controls, whether irrelevant
 	patterns are filtered during pattern mining; negatively