[Subgroup-commits] r16 - in pkg: R man

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

Author: atzmueller
Date: 2014-08-03 09:53:51 +0200 (Sun, 03 Aug 2014)
New Revision: 16

Modified:
   pkg/R/subgroup.R
   pkg/man/DiscoverSubgroups.Rd
   pkg/man/DiscoverSubgroupsByTask.Rd
Log:
change optional parameter in DiscoverySubgroups|DiscoverSubgroupsByTask: convert.df to as.df

Modified: pkg/R/subgroup.R
===================================================================
--- pkg/R/subgroup.R	2014-08-02 19:21:38 UTC (rev 15)
+++ pkg/R/subgroup.R	2014-08-03 07:53:51 UTC (rev 16)
@@ -151,7 +151,7 @@
   return(as.character(sgSelectorArray))
 }
 
-DiscoverSubgroupsByTask <- function(task, convert.df=FALSE) {
+DiscoverSubgroupsByTask <- function(task, as.df=FALSE) {
   # Internal function for setting up and performing subgroup discovery
   # Args:
   #   task: A subgroup discovery task
@@ -174,7 +174,7 @@
     patterns = append(patterns, pattern)
   }
   
-  if (convert.df) {
+  if (as.df) {
     dataFrameRules <- ToDataFrame(patterns)
     return(dataFrameRules)
   } else {
@@ -182,7 +182,7 @@
   }
 }
 
-DiscoverSubgroups <- function(source, target, config=new("SDTaskConfig"), convert.df=FALSE) {
+DiscoverSubgroups <- function(source, target, config=new("SDTaskConfig"), as.df=FALSE) {
   # Performs subgroup discovery according to target and config on data
   #
   # Args:
@@ -193,7 +193,7 @@
   # Returns:
   #   A list of subgroup patterns
   task <- CreateSDTask(source, target, config)
-  result <- DiscoverSubgroupsByTask(task, convert.df)
+  result <- DiscoverSubgroupsByTask(task, as.df)
   return(result)
 }
 

Modified: pkg/man/DiscoverSubgroups.Rd
===================================================================
--- pkg/man/DiscoverSubgroups.Rd	2014-08-02 19:21:38 UTC (rev 15)
+++ pkg/man/DiscoverSubgroups.Rd	2014-08-03 07:53:51 UTC (rev 16)
@@ -6,7 +6,7 @@
 the configuration on the data.
 }
 \usage{
-DiscoverSubgroups(source, target, config=new("SDTaskConfig"), convert.df=FALSE)
+DiscoverSubgroups(source, target, config=new("SDTaskConfig"), as.df=FALSE)
 }
 \arguments{
 \item{source}{a data.frame or the a character string giving
@@ -15,8 +15,8 @@
 to consider for subgroup discovery.}
 \item{config}{an instance of SDTaskConfig providing various
 parameters for subgroup discovery.}
-\item{convert.df}{TRUE, if the result patterns should be converted
-to a data.frame using \code{\link{ToDataFrame}}}
+\item{as.df}{TRUE, if the result patterns should be returned as
+a data.frame using \code{\link{ToDataFrame}}}
 }
 \seealso{
 \code{\link{DiscoverSubgroupsByTask}}.

Modified: pkg/man/DiscoverSubgroupsByTask.Rd
===================================================================
--- pkg/man/DiscoverSubgroupsByTask.Rd	2014-08-02 19:21:38 UTC (rev 15)
+++ pkg/man/DiscoverSubgroupsByTask.Rd	2014-08-03 07:53:51 UTC (rev 16)
@@ -5,13 +5,13 @@
 Performs subgroup discovery according to the given task.
 }
 \usage{
-DiscoverSubgroupsByTask(task, convert.df=FALSE)
+DiscoverSubgroupsByTask(task, as.df=FALSE)
 }
 \arguments{
 \item{task}{a subgroup discovery task constructed by
  CreateSDTask.}
- \item{convert.df}{TRUE, if the result patterns should be converted
-to a data.frame using \code{\link{ToDataFrame}}}
+ \item{as.df}{TRUE, if the result patterns should be returned
+as a data.frame using \code{\link{ToDataFrame}}}
 }
 \seealso{
 \code{\link{DiscoverSubgroups}}.