[Ruler-commits] r63 - pkg/ruleR/man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Tue Oct 16 12:05:15 CEST 2012
Author: doebler
Date: 2012-10-16 12:05:15 +0200 (Tue, 16 Oct 2012)
New Revision: 63
Modified:
pkg/ruleR/man/AddConstSingleRule-class.Rd
pkg/ruleR/man/AddDoubleRule-class.Rd
pkg/ruleR/man/basicDictionary.Rd
pkg/ruleR/man/calculate-methods.Rd
pkg/ruleR/man/calculate.Rd
pkg/ruleR/man/calculateSpecific-methods.Rd
pkg/ruleR/man/calculateSpecific.Rd
pkg/ruleR/man/check.Rd
pkg/ruleR/man/conCheck.Rd
pkg/ruleR/man/createDR.Rd
pkg/ruleR/man/createDictRule.Rd
pkg/ruleR/man/sequenceR.Rd
Log:
Proofread documentation. Fixed typos, clarified documentation and deleted unnecessary calls to new("IdenSingleRule").
Modified: pkg/ruleR/man/AddConstSingleRule-class.Rd
===================================================================
--- pkg/ruleR/man/AddConstSingleRule-class.Rd 2012-10-15 22:08:35 UTC (rev 62)
+++ pkg/ruleR/man/AddConstSingleRule-class.Rd 2012-10-16 10:05:15 UTC (rev 63)
@@ -1,69 +1,69 @@
-\name{AddConstSingleRule-class}
-\Rdversion{1.1}
-\docType{class}
-\alias{AddConstSingleRule-class}
-%\alias{calculateSpecific,AddConstSingleRule,numeric,ANY-method}
-
-\title{Class \code{"AddConstSingleRule"}}
-\description{
- A class for rules which add a specified constant value to the previous element of numeric sequence.
- Objects of this class inherit from \code{SingleRule}.
-}
-\section{Objects from the Class}{
-Objects can be created by calls of the form \code{new("AddConstSingleRule", constantVal)}.
-%% ~~ describe objects here ~~
-}
-\section{Slots}{
- \describe{
- \item{\code{constantVal}:}{Object of class \code{"numeric"} - a constant that will be added to the previous element of numeric sequence }
- \item{\code{previousRule}:}{Object of class \code{"SingleRule"} - a rule that will be executed before \code{AddConstSingleRule} (this is an argument used to combine different rules together)}
- \item{\code{.S3Class}:}{Object of class \code{"character"} - S3 methods apply to this object }
- }
-}
-\section{Extends}{
-Class \code{"\linkS4class{SingleRule}"}, directly.
-}
-\section{Methods}{
- \describe{
- \item{calculateSpecific}{\code{signature(x = "AddConstSingleRule", y = "numeric", z = "ANY")}: ... }
- }
-}
-\references{
-%% ~~put references to the literature/web site here~~
-}
-\author{
-Maria Rafalak <m.rafalak at practest.com.pl>
-}
-\note{
-%% ~~further notes~~
-}
-
-%% ~Make other sections like Warning with \section{Warning }{....} ~
-\seealso{
-\code{\link{calculate}},
-\code{\linkS4class{SingleRule}},
-\code{\linkS4class{DoubleRule}},
-\code{\link{createSR}},
-\code{\link{createDR}}
-
-}
-\examples{
-##[1] A rule that adds 4 to the previous element of numeric sequence
-
-m <- new("AddConstSingleRule",constantVal=4,previousRule=new("IdenSingleRule")) #or
-m <- createSR(a1=2,cv1=4,n=0)
-print(m)
-
-
-##[2] combining rules
-
-p <- new("DigSumSingleRule",previousRule=new("IdenSingleRule")) # a rule that calculates digitsum of a given element
-m <- new("AddConstSingleRule",constantVal=5, previousRule=p)
-
-# or in one step:
-# m <- createSR(a1=2, cv1=5, n=1, 5, 0)
-print(m)
-
-}
-\keyword{classes}
-\keyword{AddConstSingleRule}
+\name{AddConstSingleRule-class}
+\Rdversion{1.1}
+\docType{class}
+\alias{AddConstSingleRule-class}
+%\alias{calculateSpecific,AddConstSingleRule,numeric,ANY-method}
+
+\title{Class \code{"AddConstSingleRule"}}
+\description{
+ A class for rules which add a specified constant value to the previous element of a numeric sequence.
+ Objects of this class inherit from \code{SingleRule}.
+}
+\section{Objects from the Class}{
+Objects can be created by calls of the form \code{new("AddConstSingleRule", constantVal)}.
+%% ~~ describe objects here ~~
+}
+\section{Slots}{
+ \describe{
+ \item{\code{constantVal}:}{Object of class \code{numeric} - a constant that will be added to the previous element of numeric sequence }
+ \item{\code{previousRule}:}{Object of class \code{SingleRule} - a rule that will be executed before \code{AddConstSingleRule} (this is an argument used to combine different rules together). If no previous rule is specified, an \code{IdenSingleRule} will be used.}
+ \item{\code{.S3Class}:}{Object of class \code{character} - S3 methods apply to this object }
+ }
+}
+\section{Extends}{
+Class \code{"\linkS4class{SingleRule}"}, directly.
+}
+\section{Methods}{
+ \describe{
+ \item{calculateSpecific}{\code{signature(x = "AddConstSingleRule", y = "numeric", z = "ANY")}: ... }
+ }
+}
+\references{
+%% ~~put references to the literature/web site here~~
+}
+\author{
+Maria Rafalak <m.rafalak at practest.com.pl>
+}
+\note{
+%% ~~further notes~~
+}
+
+%% ~Make other sections like Warning with \section{Warning }{....} ~
+\seealso{
+\code{\link{calculate}},
+\code{\linkS4class{SingleRule}},
+\code{\linkS4class{DoubleRule}},
+\code{\link{createSR}},
+\code{\link{createDR}}
+
+}
+\examples{
+##[1] A rule that adds 4 to the previous element of numeric sequence
+
+m <- new("AddConstSingleRule", constantVal=4)) #or
+m <- createSR(a1=2, cv1=4, n=0)
+print(m)
+
+
+##[2] combining rules
+
+p <- new("DigSumSingleRule") # a rule that calculates digitsum of a given element
+m <- new("AddConstSingleRule",constantVal=5, previousRule=p)
+
+# or in one step:
+# m <- createSR(a1=2, cv1=5, n=1, 5, 0)
+print(m)
+
+}
+\keyword{classes}
+\keyword{AddConstSingleRule}
Modified: pkg/ruleR/man/AddDoubleRule-class.Rd
===================================================================
--- pkg/ruleR/man/AddDoubleRule-class.Rd 2012-10-15 22:08:35 UTC (rev 62)
+++ pkg/ruleR/man/AddDoubleRule-class.Rd 2012-10-16 10:05:15 UTC (rev 63)
@@ -1,86 +1,85 @@
-\name{AddDoubleRule-class}
-\Rdversion{1.1}
-\docType{class}
-\alias{AddDoubleRule-class}
-%\alias{calculateSpecific,AddDoubleRule,numeric,numeric-method}
-
-\title{Class \code{"AddDoubleRule"}}
-\description{
- A class for the rule which adds two previous elements of a number sequence.
- It inherits from class \code{DoubleRule}
-}
-\section{Objects from the Class}{
-Objects can be created by calls of the form \code{new("AddDoubleRule",... )}.
-%% ~~ describe objects here ~~
-}
-\section{Slots}{
- \describe{
- \item{\code{firstRule}:}{Object of class \code{"SingleRule"} - a rule to be executed on the first element of numeric sequence, before executing DoubleRule (doesn't need to be specified)}
- \item{\code{secondRule}:}{Object of class \code{"SingleRule"} - a rule to be executed on the second element of numeric sequence, before executing DoubleRule (doesn't need to be specified) }
- \item{\code{nextSingle}:}{Object of class \code{"SingleRule"} - a rule to be executed on the result of DoubleRule (doesn't need to be specified) }
- \item{\code{.S3Class}:}{Object of class \code{"character"} - S3 methods apply for these objects }
- }
-}
-\section{Extends}{
-Class \code{"\linkS4class{DoubleRule}"}, directly.
-}
-\section{Methods}{
- \describe{
- \item{calculateSpecific}{\code{signature(x = "AddDoubleRule", y = "numeric", z = "numeric")}: ... }
- }
-}
-\references{
-%% ~~put references to the literature/web site here~~
-}
-\author{
-Maria Rafalak <m.rafalak at practest.com.pl>
-}
-\note{
-%% ~~further notes~~
-}
-
-%% ~Make other sections like Warning with \section{Warning }{....} ~
-
-\seealso{
-\code{\link{calculate}},
-\code{\linkS4class{DoubleRule}},
-\code{\linkS4class{SingleRule}},
-\code{\link{createSR}},
-\code{\link{createDR}}
-
-
-
-}
-\examples{
-
-#[1] simple DoubleRule
-
-p <- new("AddDoubleRule")
-calculate(p,12,5) #12+5=17
-
-
-
-#[2] combining rules
-
-m <- new("DigSumSingleRule",previousRule=new("IdenSingleRule"))
-# SingleRule that calculates digitsum of an element of numeric sequence
-
-r <- new("AddConstSingleRule", constantVal=6,previousRule=new("IdenSingleRule"))
-# a SingleRule that adds constant value '6' to the element of numeric sequence
-
-f <- new("MultConstSingleRule", constantVal=2,previousRule=new("IdenSingleRule"))
-# a SingleRule that muliplies an element of a sequence by constant value '4'
-
-g <- new("AddDoubleRule", firstRule=r, secondRule=f, nextSingle=m)
-calculate(g,12,5) #10
-
-## How is rule 'g' executed ?
-## Starting elements are '12' and '5'
-## Rule 'r'(firstRule) is applied to the first element of numeric sequence (12+6=18)
-## Rule 'f'(secondRule) is applied to the second element of numeric sequence (5*2=10)
-## "AddDoubleRule" is executed on the results of firstRule and secondRule (18+10=28)
-## Rule 'm' is applies to the result of DoubleRule (2+8=10)
-
-}
-\keyword{classes}
-\keyword{AddDoubleRule}
+\name{AddDoubleRule-class}
+\Rdversion{1.1}
+\docType{class}
+\alias{AddDoubleRule-class}
+%\alias{calculateSpecific,AddDoubleRule,numeric,numeric-method}
+
+\title{Class \code{"AddDoubleRule"}}
+\description{
+ A class for the rule which adds the two previous elements of a number sequence. It inherits from class \code{DoubleRule}
+}
+\section{Objects from the Class}{
+Objects can be created by calls of the form \code{new("AddDoubleRule",... )}.
+%% ~~ describe objects here ~~
+}
+\section{Slots}{
+ \describe{
+ \item{\code{firstRule}:}{Object of class \code{"SingleRule"} - a rule to be executed on the first element of numeric sequence, before executing DoubleRule (doesn't need to be specified)}
+ \item{\code{secondRule}:}{Object of class \code{"SingleRule"} - a rule to be executed on the second element of numeric sequence, before executing DoubleRule (doesn't need to be specified) }
+ \item{\code{nextSingle}:}{Object of class \code{"SingleRule"} - a rule to be executed on the result of DoubleRule (doesn't need to be specified) }
+ \item{\code{.S3Class}:}{Object of class \code{"character"} - S3 methods apply for these objects }
+ }
+}
+\section{Extends}{
+Class \code{"\linkS4class{DoubleRule}"}, directly.
+}
+\section{Methods}{
+ \describe{
+ \item{calculateSpecific}{\code{signature(x = "AddDoubleRule", y = "numeric", z = "numeric")}: ... }
+ }
+}
+\references{
+%% ~~put references to the literature/web site here~~
+}
+\author{
+Maria Rafalak <m.rafalak at practest.com.pl>
+}
+\note{
+%% ~~further notes~~
+}
+
+%% ~Make other sections like Warning with \section{Warning }{....} ~
+
+\seealso{
+\code{\link{calculate}},
+\code{\linkS4class{DoubleRule}},
+\code{\linkS4class{SingleRule}},
+\code{\link{createSR}},
+\code{\link{createDR}}
+
+
+
+}
+\examples{
+
+#[1] simple DoubleRule
+
+p <- new("AddDoubleRule")
+calculate(p,12,5) #12+5=17
+unlist(sequenceR(1,p,8)[[1]]) # first 8 elements of Fibonacci sequence
+
+
+#[2] combining rules
+
+m <- new("DigSumSingleRule")
+# SingleRule that calculates digitsum of an element of numeric sequence
+
+r <- new("AddConstSingleRule", constantVal=6)
+# a SingleRule that adds constant value '6' to the element of numeric sequence
+
+f <- new("MultConstSingleRule", constantVal=2)
+# a SingleRule that muliplies an element of a sequence by constant value '4'
+
+g <- new("AddDoubleRule", firstRule=r, secondRule=f, nextSingle=m)
+calculate(g,12,5) #10
+
+## How is rule 'g' executed ?
+## Starting elements are '12' and '5'
+## Rule 'r'(firstRule) is applied to the first element of numeric sequence (12+6=18)
+## Rule 'f'(secondRule) is applied to the second element of numeric sequence (5*2=10)
+## "AddDoubleRule" is executed on the results of firstRule and secondRule (18+10=28)
+## Rule 'm' is applies to the result of DoubleRule (2+8=10)
+
+}
+\keyword{classes}
+\keyword{AddDoubleRule}
Modified: pkg/ruleR/man/basicDictionary.Rd
===================================================================
--- pkg/ruleR/man/basicDictionary.Rd 2012-10-15 22:08:35 UTC (rev 62)
+++ pkg/ruleR/man/basicDictionary.Rd 2012-10-16 10:05:15 UTC (rev 63)
@@ -1,27 +1,27 @@
-\name{basicDictionary}
-\alias{basicDictionary}
-\docType{data}
-\title{
-basicDictionary
-}
-\description{
-a default dictionary of rulesused to generate test if no other dictionary is specyfied by user.
-It contains of objects of class \code{DictionaryRule}.
-}
-\usage{basicDictionary}
-\format{
-
-}
-\details{
-%% ~~ If necessary, more details than the __description__ above ~~
-}
-\source{
-%% ~~ reference to a publication or URL from which the data were obtained ~~
-}
-\references{
-%% ~~ possibly secondary sources and usages ~~
-}
-\examples{
-
-}
-\keyword{datasets}
+\name{basicDictionary}
+\alias{basicDictionary}
+\docType{data}
+\title{
+basicDictionary
+}
+\description{
+a default dictionary of rules used to generate a test if no other dictionary is specified by user.
+It contains objects of class \code{DictionaryRule}.
+}
+\usage{basicDictionary}
+\format{
+
+}
+\details{
+%% ~~ If necessary, more details than the __description__ above ~~
+}
+\source{
+%% ~~ reference to a publication or URL from which the data were obtained ~~
+}
+\references{
+%% ~~ possibly secondary sources and usages ~~
+}
+\examples{
+
+}
+\keyword{datasets}
Modified: pkg/ruleR/man/calculate-methods.Rd
===================================================================
--- pkg/ruleR/man/calculate-methods.Rd 2012-10-15 22:08:35 UTC (rev 62)
+++ pkg/ruleR/man/calculate-methods.Rd 2012-10-16 10:05:15 UTC (rev 63)
@@ -1,29 +1,32 @@
-\name{calculate-methods}
-\docType{methods}
-\alias{calculate-methods}
-%\alias{calculate,DoubleRule,numeric,numeric-method}
-%\alias{calculate,SingleRule,numeric,ANY-method}
-\title{ ~~ Methods for Function \code{calculate} ~~}
-\description{
- Methods to execute rules on specyfied numeric arguments.
-}
-\section{Methods}{
-\describe{
-
-\item{\code{signature(x = "DoubleRule", y = "numeric", z = "numeric")}}{
-%% ~~describe this method here~~
-}
-
-\item{\code{signature(x = "SingleRule", y = "numeric", z = "ANY")}}{
-'z' argument is ignored for objects of class "SingleRule"
-}
-}}
-
-
-\seealso{
-\code{\link{calculateSpecific-methods}}
-}
-
-
-\keyword{methods}
-\keyword{ ~~ other possible keyword(s) ~~ }
+\name{calculate-methods}
+\docType{methods}
+\alias{calculate-methods}
+%\alias{calculate,DoubleRule,numeric,numeric-method}
+%\alias{calculate,SingleRule,numeric,ANY-method}
+\title{ ~~ Methods for Function \code{calculate} ~~}
+\description{
+Methods to execute rules on specified numeric arguments.
+}
+\section{Methods}{
+\describe{
+
+\item{\code{signature(x = "DoubleRule", y = "numeric", z = "numeric")}}{
+%% ~~describe this method here~~
+}
+
+\item{\code{signature(x = "SingleRule", y = "numeric", z = "ANY")}}{
+'z' argument is ignored for objects of class "SingleRule"
+}
+}}
+
+\details{
+\code{calculate} expects \code{y} to be \code{numeric} of length 1. Only some rules will support vectorization.
+}
+
+\seealso{
+\code{\link{calculateSpecific-methods}}
+}
+
+
+\keyword{methods}
+%\keyword{ ~~ other possible keyword(s) ~~ }
Modified: pkg/ruleR/man/calculate.Rd
===================================================================
--- pkg/ruleR/man/calculate.Rd 2012-10-15 22:08:35 UTC (rev 62)
+++ pkg/ruleR/man/calculate.Rd 2012-10-16 10:05:15 UTC (rev 63)
@@ -1,76 +1,70 @@
-\name{calculate}
-\alias{calculate}
-
-\title{A function to calculate a rule on given object
-}
-\description{
-A function to calculate a rule on given element
-}
-\usage{
-calculate(x, y, z = NULL)
-}
-%- maybe also 'usage' for other objects documented here.
-\arguments{
- \item{x}{
-- an object of class \code{SingleRule} or \code{DoubleRule}
-}
- \item{y}{
-- first element of numeric sequence
-}
- \item{z}{
-- second element of numeric sequence
-}
-}
-\details{
-argument \code{z} is ignored if \code{x} inherits from class \code{SingleRule}
-}
-\value{
-function returs single value of class \code{numeric}
-}
-\references{
-%% ~put references to the literature/web site here ~
-}
-\author{
-%% ~~who you are~~
-}
-\note{
-%% ~~further notes~~
-}
-
-%% ~Make other sections like Warning with \section{Warning }{....} ~
-
-\seealso{
-\code{\link{calculateSpecific}}
-}
-\examples{
-
-#[1] for objects of class SingleRule
-
-# a rule adding a constant value '6' to the element of numeric sequence
-p<-new("AddConstSingleRule", constantVal=6, previousRule=new("IdenSingleRule"))
-
-calculate(p,4)# 4+6=10
-
-
-
-#[2] for combined objects
-
-m<-new("DigSumSingleRule",previousRule=new("IdenSingleRule"))
-r<-new("AddConstSingleRule", constantVal=6,previousRule=new("IdenSingleRule"))
-g<-new("MultDoubleRule", firstRule=m, secondRule=m, nextSingle=r)
-
-calculate(g,12,34) #27
-
-# rule 'm' (first rule) is executed on the first element of numeric sequence (1+2=3)
-# rule 'm' (secodn rule) is executed on the second element of numeric sequence (3+4=7)
-# rule 'g' is executed on the result of firstRule and secondRule (3*7=21)
-# rule 'r' (nextSingle) is executed on the result of DoubleRule (21+6=27)
-#[(1+2) * (3+4) ]+6 = 27
-
-
-
-}
-% Add one or more standard keywords, see file 'KEYWORDS' in the
-% R documentation directory.
-\keyword{ ~kwd1 }
-\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
+\name{calculate}
+\alias{calculate}
+
+\title{Caculate the next element of a sequence
+}
+\description{
+Caculate the next element of a sequence from previous element(s) and a rule.}
+\usage{
+calculate(x, y, z = NULL)
+}
+%- maybe also 'usage' for other objects documented here.
+\arguments{
+ \item{x}{
+- an object of class \code{SingleRule} or \code{DoubleRule}
+}
+ \item{y}{
+- first element of numeric sequence
+}
+ \item{z}{
+- second element of numeric sequence
+}
+}
+\details{
+argument \code{z} is ignored if \code{x} inherits from class \code{SingleRule}
+}
+\value{
+function returs single value of class \code{numeric}
+}
+\references{
+%% ~put references to the literature/web site here ~
+}
+\author{
+%% ~~who you are~~
+}
+\note{
+%% ~~further notes~~
+}
+
+%% ~Make other sections like Warning with \section{Warning }{....} ~
+
+\seealso{
+\code{\link{calculateSpecific}}
+}
+\examples{
+
+#[1] for objects of class SingleRule
+
+# a rule adding a constant value '6' to the element of numeric sequence
+p<-new("AddConstSingleRule", constantVal=6)
+calculate(p,4)# 4+6=10
+
+
+#[2] for combined objects
+
+m<-new("DigSumSingleRule")
+r<-new("AddConstSingleRule", constantVal=6)
+g<-new("MultDoubleRule", firstRule=m, secondRule=m, nextSingle=r)
+
+calculate(g,12,34) #27
+
+# rule 'm' (first rule) is executed on the first element of numeric sequence (1+2=3)
+# rule 'm' (second rule) is executed on the second element of numeric sequence (3+4=7)
+# rule 'g' is executed on the result of firstRule and secondRule (3*7=21)
+# rule 'r' (nextSingle) is executed on the result of DoubleRule (21+6=27)
+#[(1+2) * (3+4)] + 6 = 27
+}
+% Add one or more standard keywords, see file 'KEYWORDS' in the
+% R documentation directory.
+%\keyword{ ~kwd1 }
+%\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
Modified: pkg/ruleR/man/calculateSpecific-methods.Rd
===================================================================
--- pkg/ruleR/man/calculateSpecific-methods.Rd 2012-10-15 22:08:35 UTC (rev 62)
+++ pkg/ruleR/man/calculateSpecific-methods.Rd 2012-10-16 10:05:15 UTC (rev 63)
@@ -1,77 +1,77 @@
-\name{calculateSpecific-methods}
-\docType{methods}
-\alias{calculateSpecific-methods}
-\alias{calculateSpecific,AddConstSingleRule,numeric,ANY-method}
-\alias{calculateSpecific,AddDoubleRule,numeric,numeric-method}
-\alias{calculateSpecific,DigSumSingleRule,numeric,ANY-method}
-\alias{calculateSpecific,DivDoubleRule,numeric,numeric-method}
-\alias{calculateSpecific,ExpDoubleRule,numeric,numeric-method}
-\alias{calculateSpecific,IdenSingleRule,numeric,ANY-method}
-\alias{calculateSpecific,ModuloDoubleRule,numeric,numeric-method}
-\alias{calculateSpecific,MultConstSingleRule,numeric,ANY-method}
-\alias{calculateSpecific,MultDoubleRule,numeric,numeric-method}
-\alias{calculateSpecific,NegativeSingleRule,numeric,ANY-method}
-\alias{calculateSpecific,SingleRule,numeric,ANY-method}
-\alias{calculateSpecific,SubsConstSingleRule,numeric,ANY-method}
-\alias{calculateSpecific,SubsDoubleRule,numeric,numeric-method}
-\title{ ~~ Methods for Function \code{calculateSpecific} ~~}
-\description{
- Methods for executing specyfied rules dedicated for every basic rule separately.
-}
-\section{Methods}{
-\describe{
-
-\item{\code{signature(x = "AddConstSingleRule", y = "numeric", z = "ANY")}}{
-method to execute rules on objects of class \code{AddConstSingleRule}
-}
-
-\item{\code{signature(x = "AddDoubleRule", y = "numeric", z = "numeric")}}{
-method to execute rules on objects of class \code{AddDoubleRule}
-}
-
-\item{\code{signature(x = "DigSumSingleRule", y = "numeric", z = "ANY")}}{
-method to execute rules on objects of class \code{DigSumSingleRule}
-}
-
-\item{\code{signature(x = "DivDoubleRule", y = "numeric", z = "numeric")}}{
-method to execute rules on objects of class \code{DivDoubleRule}
-}
-
-\item{\code{signature(x = "ExpDoubleRule", y = "numeric", z = "numeric")}}{
-method to execute rules on objects of class \code{ExpDoubleRule}
-}
-
-\item{\code{signature(x = "IdenSingleRule", y = "numeric", z = "ANY")}}{
-method to execute rules on objects of class \code{IdenSingleRule}
-}
-
-\item{\code{signature(x = "ModuloDoubleRule", y = "numeric", z = "numeric")}}{
-method to execute rules on objects of class \code{ModuloDoubleRule}
-}
-
-\item{\code{signature(x = "MultConstSingleRule", y = "numeric", z = "ANY")}}{
-method to execute rules on objects of class \code{MultConstSingleRule}
-}
-
-\item{\code{signature(x = "MultDoubleRule", y = "numeric", z = "numeric")}}{
-method to execute rules on objects of class \code{MultDoubleRule}
-}
-
-\item{\code{signature(x = "NegativeSingleRule", y = "numeric", z = "ANY")}}{
-method to execute rules on objects of class \code{NegativeSingleRule}
-}
-
-\item{\code{signature(x = "SingleRule", y = "numeric", z = "ANY")}}{
-method to execute rules on objects of class \code{SingleRule}
-}
-
-\item{\code{signature(x = "SubsConstSingleRule", y = "numeric", z = "ANY")}}{
-method to execute rules on objects of class \code{SubsConstSingleRule}
-}
-
-\item{\code{signature(x = "SubsDoubleRule", y = "numeric", z = "numeric")}}{
-method to execute rules on objects of class \code{SubsDoubleRule}
-}
-}}
-\keyword{methods}
-\keyword{ ~~ other possible keyword(s) ~~ }
+\name{calculateSpecific-methods}
+\docType{methods}
+\alias{calculateSpecific-methods}
+\alias{calculateSpecific,AddConstSingleRule,numeric,ANY-method}
+\alias{calculateSpecific,AddDoubleRule,numeric,numeric-method}
+\alias{calculateSpecific,DigSumSingleRule,numeric,ANY-method}
+\alias{calculateSpecific,DivDoubleRule,numeric,numeric-method}
+\alias{calculateSpecific,ExpDoubleRule,numeric,numeric-method}
+\alias{calculateSpecific,IdenSingleRule,numeric,ANY-method}
+\alias{calculateSpecific,ModuloDoubleRule,numeric,numeric-method}
+\alias{calculateSpecific,MultConstSingleRule,numeric,ANY-method}
+\alias{calculateSpecific,MultDoubleRule,numeric,numeric-method}
+\alias{calculateSpecific,NegativeSingleRule,numeric,ANY-method}
+\alias{calculateSpecific,SingleRule,numeric,ANY-method}
+\alias{calculateSpecific,SubsConstSingleRule,numeric,ANY-method}
+\alias{calculateSpecific,SubsDoubleRule,numeric,numeric-method}
+\title{ ~~ Methods for Function \code{calculateSpecific} ~~}
+\description{
+Methods for executing specified rules dedicated for every basic rule separately.
+}
+\section{Methods}{
+\describe{
+
+\item{\code{signature(x = "AddConstSingleRule", y = "numeric", z = "ANY")}}{
+method to execute rules on objects of class \code{AddConstSingleRule}
+}
+
+\item{\code{signature(x = "AddDoubleRule", y = "numeric", z = "numeric")}}{
+method to execute rules on objects of class \code{AddDoubleRule}
+}
+
+\item{\code{signature(x = "DigSumSingleRule", y = "numeric", z = "ANY")}}{
+method to execute rules on objects of class \code{DigSumSingleRule}
+}
+
+\item{\code{signature(x = "DivDoubleRule", y = "numeric", z = "numeric")}}{
+method to execute rules on objects of class \code{DivDoubleRule}
+}
+
+\item{\code{signature(x = "ExpDoubleRule", y = "numeric", z = "numeric")}}{
+method to execute rules on objects of class \code{ExpDoubleRule}
+}
+
+\item{\code{signature(x = "IdenSingleRule", y = "numeric", z = "ANY")}}{
+method to execute rules on objects of class \code{IdenSingleRule}
+}
+
+\item{\code{signature(x = "ModuloDoubleRule", y = "numeric", z = "numeric")}}{
+method to execute rules on objects of class \code{ModuloDoubleRule}
+}
+
+\item{\code{signature(x = "MultConstSingleRule", y = "numeric", z = "ANY")}}{
+method to execute rules on objects of class \code{MultConstSingleRule}
+}
+
+\item{\code{signature(x = "MultDoubleRule", y = "numeric", z = "numeric")}}{
+method to execute rules on objects of class \code{MultDoubleRule}
+}
+
+\item{\code{signature(x = "NegativeSingleRule", y = "numeric", z = "ANY")}}{
+method to execute rules on objects of class \code{NegativeSingleRule}
+}
+
+\item{\code{signature(x = "SingleRule", y = "numeric", z = "ANY")}}{
+method to execute rules on objects of class \code{SingleRule}
+}
+
+\item{\code{signature(x = "SubsConstSingleRule", y = "numeric", z = "ANY")}}{
+method to execute rules on objects of class \code{SubsConstSingleRule}
+}
+
+\item{\code{signature(x = "SubsDoubleRule", y = "numeric", z = "numeric")}}{
+method to execute rules on objects of class \code{SubsDoubleRule}
+}
+}}
+\keyword{methods}
+%\keyword{ ~~ other possible keyword(s) ~~ }
Modified: pkg/ruleR/man/calculateSpecific.Rd
===================================================================
--- pkg/ruleR/man/calculateSpecific.Rd 2012-10-15 22:08:35 UTC (rev 62)
+++ pkg/ruleR/man/calculateSpecific.Rd 2012-10-16 10:05:15 UTC (rev 63)
@@ -1,69 +1,65 @@
-\name{calculateSpecific}
-\alias{calculateSpecific}
-%- Also NEED an '\alias' for EACH other topic documented here.
-\title{
-calculateSpecific
-}
-\description{
-Every rule is an object of separate class, which inherits either from
-\code{SingleRule} or \code{DoubleRule} virtual class. This is why for every rule there is defined
- \code{calculateSpecific} method specyfying how to transform arguments supplied to
-function \code{calculate}. }
-
-\usage{
-calculateSpecific(x, y, z = NULL)
-}
-%- maybe also 'usage' for other objects documented here.
-\arguments{
- \item{x}{
-- an object of class \code{SingleRule} or \code{DoubleRule}
-}
- \item{y}{
-- first element of numeric sequence
-}
- \item{z}{
-- second element of numeric sequence
-}
-}
-\details{
-argument \code{z} is ignored if \code{x} inherits from class \code{SingleRule}
-}
-\value{
-function returs single value of class \code{numeric}
-%% If it is a LIST, use
-%% \item{comp1 }{Description of 'comp1'}
-%% \item{comp2 }{Description of 'comp2'}
-%% ...
-}
-\references{
-%% ~put references to the literature/web site here ~
-}
-\author{
-%% ~~who you are~~
-}
-\note{
-%% ~~further notes~~
-}
-
-%% ~Make other sections like Warning with \section{Warning }{....} ~
-
-\seealso{
-%% ~~objects to See Also as \code{\link{help}}, ~~~
-}
-\examples{
-
-#setClass("ExpDoubleRule", contains="DoubleRule",S3methods=TRUE)
-#
-#setMethod("calculateSpecific",
-# signature(x="ExpDoubleRule", y="numeric", z="numeric"),
-# function(x,y,z){
-# return(y^z)
-# })
-
-
-
-}
-% Add one or more standard keywords, see file 'KEYWORDS' in the
-% R documentation directory.
-\keyword{ ~kwd1 }
-\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
+\name{calculateSpecific}
+\alias{calculateSpecific}
+%- Also NEED an '\alias' for EACH other topic documented here.
+\title{
+calculateSpecific
+}
+\description{
+Every rule is an object of a class, which inherits either from
+\code{SingleRule} or \code{DoubleRule} virtual class. This is why for every rule there is a \code{calculateSpecific} method specifying how to transform arguments supplied to the \code{\link{calculate}} function.}
+
+\usage{
+calculateSpecific(x, y, z = NULL)
+}
+%- maybe also 'usage' for other objects documented here.
+\arguments{
+ \item{x}{
+- an object of class \code{SingleRule} or \code{DoubleRule}
+}
+ \item{y}{
+- first element of numeric sequence
+}
+ \item{z}{
+- second element of numeric sequence
+}
+}
+\details{
+argument \code{z} is ignored if \code{x} inherits from class \code{SingleRule}
+}
+\value{
+function returns a single value of class \code{numeric}
+%% If it is a LIST, use
+%% \item{comp1 }{Description of 'comp1'}
+%% \item{comp2 }{Description of 'comp2'}
+%% ...
+}
+\references{
+%% ~put references to the literature/web site here ~
+}
+\author{
+%% ~~who you are~~
+}
+\note{
+%% ~~further notes~~
+}
+
+%% ~Make other sections like Warning with \section{Warning }{....} ~
+
+\seealso{
+%% ~~objects to See Also as \code{\link{help}}, ~~~
+}
+\examples{
+\dontrun{
+setClass("ExpDoubleRule", contains="DoubleRule",S3methods=TRUE)
+
+setMethod("calculateSpecific",
+ signature(x="ExpDoubleRule", y="numeric", z="numeric"),
+ function(x,y,z){
+ return(y^z)
+ })
+}
+}
+% Add one or more standard keywords, see file 'KEYWORDS' in the
+% R documentation directory.
+%\keyword{ ~kwd1 }
+%\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
Modified: pkg/ruleR/man/check.Rd
===================================================================
--- pkg/ruleR/man/check.Rd 2012-10-15 22:08:35 UTC (rev 62)
+++ pkg/ruleR/man/check.Rd 2012-10-16 10:05:15 UTC (rev 63)
@@ -1,55 +1,49 @@
-\name{check}
-\alias{check}
-%- Also NEED an '\alias' for EACH other topic documented here.
-\title{function \code{check}
-}
-\description{function checking if generated sequence is constant, or has elements greater/smaller than the limit set by user.
-}
-\usage{check(items,result,element_range)
-}
-%- maybe also 'usage' for other objects documented here.
-\arguments{
- \item{items}{
-a list of already generated items
-}
- \item{result}{numeric sequence thatis to be checked
-
-}
- \item{element_range}{
-maximum and minimum values of elements of the numeric sequence
-}
-}
-\details{
-Function compares result with elements of list \code{items} that have the same length as 'result'argument
-}
-\value{
-Result od \code{check} is a list:
-
-
-\item{$result}{numeric sequence that is later added \code{items} matrix in \code{automaticTest}}
-\item{$fun}{rule used to create the \code{$result} functioned that is later saved to \code{rules} list in \code{automaticTest}}
-
-}
-\references{
-%% ~put references to the literature/web site here ~
-}
-\author{
-%% ~~who you are~~
-}
-\note{
-%% ~~further notes~~
-}
-
-%% ~Make other sections like Warning with \section{Warning }{....} ~
-
-\seealso{
-\code{\link{createTest}}
-
-}
-\examples{
-
-
-}
-
-\keyword{internal}
-\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
+\name{check}
+\alias{check}
+%- Also NEED an '\alias' for EACH other topic documented here.
+\title{function \code{check}
+}
+\description{check if generated sequence is constant, or has elements greater/smaller than the limit set by user.
+}
+\usage{check(items,result,element_range)
+}
+%- maybe also 'usage' for other objects documented here.
+\arguments{
+ \item{items}{
+a list of already generated items
+}
+ \item{result}{numeric sequence that is to be checked
+}
+ \item{element_range}{
+maximum and minimum values of elements of the numeric sequence
+}
+}
+\details{
+Function compares result with elements of list \code{items} that have the same length as 'result' argument
+}
+\value{
+\code{check} outputs a list:
+
+\item{$result}{numeric sequence that is later added \code{items} matrix in \code{automaticTest}}
+\item{$fun}{rule used to create the \code{$result} functioned that is later saved to \code{rules} list in \code{\link{createTest}}}
+}
+\references{
+%% ~put references to the literature/web site here ~
+}
+\author{
+%% ~~who you are~~
+}
+\note{
+%% ~~further notes~~
+}
+
+%% ~Make other sections like Warning with \section{Warning }{....} ~
+
+\seealso{
+\code{\link{createTest}}
+}
+%\examples{
+%}
+
+\keyword{internal}
+%\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
Modified: pkg/ruleR/man/conCheck.Rd
===================================================================
--- pkg/ruleR/man/conCheck.Rd 2012-10-15 22:08:35 UTC (rev 62)
+++ pkg/ruleR/man/conCheck.Rd 2012-10-16 10:05:15 UTC (rev 63)
@@ -1,51 +1,51 @@
-\name{conCheck}
-\alias{conCheck}
-%- Also NEED an '\alias' for EACH other topic documented here.
-\title{
-function
-}
-\description{
-A function that check whether generated number sequence is constant.
-}
-\usage{
-conCheck(x)
-}
-%- maybe also 'usage' for other objects documented here.
-\arguments{
- \item{x}{
-numeric sequence as a list
-}
-}
-\details{
-\code{conCheck} is used by function \code{check}
-}
-\value{
-
-Function can return two values:
-
-\item{1}{numeric sequence is not constant}
-\item{0}{numeric sequence is constant}
-
-}
-\references{
-%% ~put references to the literature/web site here ~
-}
-\author{
-%% ~~who you are~~
-}
-\note{
-%% ~~further notes~~
-}
-
-%% ~Make other sections like Warning with \section{Warning }{....} ~
-
-\seealso{
-%% ~~objects to See Also as \code{\link{help}}, ~~~
-}
-\examples{
-
-}
-% Add one or more standard keywords, see file 'KEYWORDS' in the
-% R documentation directory.
-\keyword{internal}
-\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
+\name{conCheck}
+\alias{conCheck}
+%- Also NEED an '\alias' for EACH other topic documented here.
+\title{
+function
+}
+\description{
+A function that check whether generated number sequence is constant.
+}
+\usage{
+conCheck(x)
+}
+%- maybe also 'usage' for other objects documented here.
+\arguments{
+ \item{x}{
+numeric sequence as a list
+}
+}
+\details{
+\code{conCheck} is used by function \code{check}
+}
+\value{
+
+Function can return two values:
+
+\item{1}{numeric sequence is not constant}
+\item{0}{numeric sequence is constant}
+
+}
+\references{
+%% ~put references to the literature/web site here ~
+}
+\author{
+%% ~~who you are~~
+}
+\note{
+%% ~~further notes~~
+}
+
+%% ~Make other sections like Warning with \section{Warning }{....} ~
+
+\seealso{
+%% ~~objects to See Also as \code{\link{help}}, ~~~
+}
+\examples{
+
+}
+% Add one or more standard keywords, see file 'KEYWORDS' in the
+% R documentation directory.
+\keyword{internal}
+%\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
Modified: pkg/ruleR/man/createDR.Rd
===================================================================
--- pkg/ruleR/man/createDR.Rd 2012-10-15 22:08:35 UTC (rev 62)
+++ pkg/ruleR/man/createDR.Rd 2012-10-16 10:05:15 UTC (rev 63)
@@ -1,138 +1,138 @@
-\name{createDR}
-\alias{createDR}
-%- Also NEED an '\alias' for EACH other topic documented here.
[TRUNCATED]
To get the complete diff run:
svnlook diff /svnroot/ruler -r 63
More information about the Ruler-commits
mailing list