[Ruler-commits] r64 - pkg/ruleR/man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Tue Oct 16 20:46:31 CEST 2012
Author: doebler
Date: 2012-10-16 20:46:31 +0200 (Tue, 16 Oct 2012)
New Revision: 64
Modified:
pkg/ruleR/man/DictionaryRule-class.Rd
pkg/ruleR/man/DigSumSingleRule-class.Rd
pkg/ruleR/man/DoubleRule-class.Rd
pkg/ruleR/man/IdenSingleRule-class.Rd
pkg/ruleR/man/MultConstSingleRule-class.Rd
pkg/ruleR/man/MultDoubleRule-class.Rd
pkg/ruleR/man/SingleRule-class.Rd
pkg/ruleR/man/createSR.Rd
pkg/ruleR/man/createTest.Rd
pkg/ruleR/man/digits.Rd
pkg/ruleR/man/doubleRules.Rd
pkg/ruleR/man/duplicate.Rd
pkg/ruleR/man/extract_double_comment.Rd
pkg/ruleR/man/extract_single_comment.Rd
pkg/ruleR/man/generateRule.Rd
pkg/ruleR/man/generate_cv.Rd
pkg/ruleR/man/nest.Rd
pkg/ruleR/man/print.DoubleRule.Rd
pkg/ruleR/man/print.Rule.Rd
pkg/ruleR/man/print.SingleRule.Rd
pkg/ruleR/man/ruleR-package.Rd
pkg/ruleR/man/sequenceR.Rd
pkg/ruleR/man/singleRules.Rd
pkg/ruleR/man/split_dict.Rd
pkg/ruleR/man/val.Rd
pkg/ruleR/man/writing_double.Rd
pkg/ruleR/man/writing_single.Rd
pkg/ruleR/man/ws.Rd
Log:
Finished proofreading documentation
Modified: pkg/ruleR/man/DictionaryRule-class.Rd
===================================================================
--- pkg/ruleR/man/DictionaryRule-class.Rd 2012-10-16 10:05:15 UTC (rev 63)
+++ pkg/ruleR/man/DictionaryRule-class.Rd 2012-10-16 18:46:31 UTC (rev 64)
@@ -1,46 +1,46 @@
-\name{DictionaryRule-class}
-\Rdversion{1.1}
-\docType{class}
-\alias{DictionaryRule-class}
-
-\title{Class \code{"DictionaryRule"}}
-\description{
-A class of objects used to form a dictionary of rules for a test.
-}
-\section{Objects from the Class}{
-Objects can be created by calls of the form \code{new("DictionaryRule", ...)} \cr or
-\code{createDictRule(index,range=c(-15:-1,1:15))}
-%% ~~ describe objects here ~~
-}
-\section{Slots}{
- \describe{
- \item{\code{rule}:}{Object of class \code{"Rule"} - it can be either \code{SingleRule} or \code{DoubleRule} }
- \item{\code{range}:}{Object of class \code{"vecORnull"} a range from which a constant value can be generated. \cr
- For objects of class \code{DoubleRule} it will be \code{NULL} }
- \item{\code{.S3Class}:}{Object of class \code{"character"} ~~ }
- }
-}
-\section{Methods}{
-No methods defined with class "DictionaryRule" in the signature.
-}
-\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{createDictRule}},\code{\link{createTest}}, \code{\linkS4class{SingleRule}}, \code{\linkS4class{DoubleRule}}
-%% ~~or \code{\linkS4class{CLASSNAME}} for links to other classes ~~~
-}
-\examples{
-
-%%
-}
-\keyword{classes}
+\name{DictionaryRule-class}
+\Rdversion{1.1}
+\docType{class}
+\alias{DictionaryRule-class}
+
+\title{Class \code{"DictionaryRule"}}
+\description{
+A class of objects used to form a dictionary of rules for a test.
+}
+\section{Objects from the Class}{
+Objects can be created by calls of the form \code{new("DictionaryRule", ...)} \cr or
+\code{createDictRule(index,range=c(-15:-1,1:15))}
+%% ~~ describe objects here ~~
+}
+\section{Slots}{
+ \describe{
+ \item{\code{rule}:}{an object of class \code{Rule}, i.e. either \code{SingleRule} or \code{DoubleRule} }
+ \item{\code{range}:}{an object of class \code{vecORnull}, i.e. either a vector or a \code{NULL}. In the former case a range from which constant values can be generated. \cr
+ For objects of class \code{DoubleRule} it will be \code{NULL} }
+ \item{\code{.S3Class}:}{Object of class \code{character}}
+ }
+}
+\section{Methods}{
+No methods defined with class "DictionaryRule" in the signature.
+}
+\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{createDictRule}},\code{\link{createTest}}, \code{\linkS4class{SingleRule}}, \code{\linkS4class{DoubleRule}}
+%% ~~or \code{\linkS4class{CLASSNAME}} for links to other classes ~~~
+}
+\examples{
+
+%%
+}
+\keyword{classes}
Modified: pkg/ruleR/man/DigSumSingleRule-class.Rd
===================================================================
--- pkg/ruleR/man/DigSumSingleRule-class.Rd 2012-10-16 10:05:15 UTC (rev 63)
+++ pkg/ruleR/man/DigSumSingleRule-class.Rd 2012-10-16 18:46:31 UTC (rev 64)
@@ -1,67 +1,67 @@
-\name{DigSumSingleRule-class}
-\Rdversion{1.1}
-\docType{class}
-\alias{DigSumSingleRule-class}
-%\alias{calculateSpecific,DigSumSingleRule,numeric,ANY-method}
-
-\title{Class \code{"DigSumSingleRule"}}
-\description{
-A class for rules calculating a sum of digits of a single element of numeric sequence.
-It inherits from class \code{SingleRule}.
-}
-\section{Objects from the Class}{
-Objects can be created by calls of the form \code{new("DigSumSingleRule", ...)}.
-
-}
-\section{Slots}{
- \describe{
- \item{\code{previousRule}:}{Object of class \code{"SingleRule"} rule to be executed on an element of numeric sequence before \code{DigSumSingleRule}, by default is \code{NULL}}.
- \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 = "DigSumSingleRule", y = "numeric", z = "ANY")}: ... }
- }
-}
-\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{calculate}},
-\code{\link{createSR}},
-\code{\link{createDR}},
-\code{\linkS4class{SingleRule}}
-}
-\examples{
-
-##[1] simple single rule
-b<-new("DigSumSingleRule")
-print(b)
-
-b<-createSR(a1=4,n=0) #See 'createSR' for details
-print(b)
-
-##[2] combining single rules
-b<-new("DigSumSingleRule",previousRule=new("DigSumSingleRule"))#or b<-createSR(a1=5,cv1=0,n=1,5,0)
-print(b)
-
-#name: DigSumSingleRule
-#name: DigSumSingleRule
-
-calculate(b,785) #2 because 7+8+5=20; 2+0=2
-
-}
-\keyword{classes}
+\name{DigSumSingleRule-class}
+\Rdversion{1.1}
+\docType{class}
+\alias{DigSumSingleRule-class}
+%\alias{calculateSpecific,DigSumSingleRule,numeric,ANY-method}
+
+\title{Class \code{DigSumSingleRule}}
+\description{
+A class for rules calculating a sum of digits of a single element of numeric sequence.
+It inherits from class \code{SingleRule}.
+}
+\section{Objects from the Class}{
+Objects can be created by calls of the form \code{new("DigSumSingleRule", ...)}.
+
+}
+\section{Slots}{
+ \describe{
+ \item{\code{previousRule}:}{Object of class \code{"SingleRule"} rule to be executed on an element of numeric sequence before \code{DigSumSingleRule}, by default is \code{NULL}}.
+ \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 = "DigSumSingleRule", y = "numeric", z = "ANY")}: ... }
+ }
+}
+\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{calculate}},
+\code{\link{createSR}},
+\code{\link{createDR}},
+\code{\linkS4class{SingleRule}}
+}
+\examples{
+
+##[1] simple single rule
+b<-new("DigSumSingleRule")
+print(b)
+
+b<-createSR(a1=4,n=0) #See 'createSR' for details
+print(b)
+
+##[2] combining single rules
+b<-new("DigSumSingleRule",previousRule=new("DigSumSingleRule"))#or b<-createSR(a1=5,cv1=0,n=1,5,0)
+print(b)
+
+#name: DigSumSingleRule
+#name: DigSumSingleRule
+
+calculate(b,785) #2 because 7+8+5=20; 2+0=2
+
+}
+\keyword{classes}
Modified: pkg/ruleR/man/DoubleRule-class.Rd
===================================================================
--- pkg/ruleR/man/DoubleRule-class.Rd 2012-10-16 10:05:15 UTC (rev 63)
+++ pkg/ruleR/man/DoubleRule-class.Rd 2012-10-16 18:46:31 UTC (rev 64)
@@ -1,52 +1,52 @@
-\name{DoubleRule-class}
-\Rdversion{1.1}
-\docType{class}
-\alias{DoubleRule-class}
-
-\title{Class \code{"DoubleRule"}}
-\description{
-A class for rules operating on two elements of numeric sequence.
-It is a virtual class - so no objects of this class are generated.
-All classes for specyfic rules operating on two arguiments (ex. \code{AddDoubleRule},\code{DivDoubleRule} etc.)
-inherit from class \code{DoubleRule}.
-}
-\section{Objects from the Class}{
-%% ~~ describe objects here ~~
-}
-\section{Slots}{
- \describe{
- \item{\code{firstRule}:}{ Object of class \code{"SingleRule"} \code{SingleRule} to be executed on the first element of numeric sequence (before the \code{DoubleRule}).This doesn't need to be specyfied. }
- \item{\code{secondRule}:}{ Object of class \code{"SingleRule"} \code{SingleRule} to be executed on the second element of numeric sequence (before the \code{DoubleRule}). This doesn't need to be specyfied. }
- \item{\code{nextSingle}:}{ Object of class \code{"SingleRule"} \code{SingleRule} to be executed on the result of \code{DoubleRule}.This doesn't need to be specyfied.}
- \item{\code{.S3Class}:}{Object of class \code{"character"} Object of class \code{"character"} S3 methods apply for these objects }
- }
-}
-\section{Methods}{
- \describe{
- \item{calculate}{\code{signature(x = "DoubleRule", y = "numeric", z = "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{doubleRules}},
-\code{\linkS4class{AddDoubleRule}},
-\code{\linkS4class{MultDoubleRule}},
-\code{\link{createSR}},
-\code{\link{createDR}}
-
-}
-\examples{
-
-}
-\keyword{classes}
+\name{DoubleRule-class}
+\Rdversion{1.1}
+\docType{class}
+\alias{DoubleRule-class}
+
+\title{Class \code{"DoubleRule"}}
+\description{
+A class for rules operating on two elements of a numeric sequence.
+It is a virtual class - so no objects of this class are generated.
+All classes for specific rules operating on two arguiments (ex. \code{AddDoubleRule},\code{DivDoubleRule} etc.)
+inherit from class \code{DoubleRule}.
+}
+\section{Objects from the Class}{
+%% ~~ describe objects here ~~
+}
+\section{Slots}{
+ \describe{
+ \item{\code{firstRule}:}{ Object of class \code{"SingleRule"} \code{SingleRule} to be executed on the first element of numeric sequence (before the \code{DoubleRule}). This doesn't need to be specified. }
+ \item{\code{secondRule}:}{ Object of class \code{"SingleRule"} \code{SingleRule} to be executed on the second element of numeric sequence (before the \code{DoubleRule}). This doesn't need to be specified. }
+ \item{\code{nextSingle}:}{ Object of class \code{"SingleRule"} \code{SingleRule} to be executed on the result of \code{DoubleRule}. This doesn't need to be specified.}
+ \item{\code{.S3Class}:}{Object of class \code{"character"} Object of class \code{"character"} S3 methods apply for these objects }
+ }
+}
+\section{Methods}{
+ \describe{
+ \item{calculate}{\code{signature(x = "DoubleRule", y = "numeric", z = "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{doubleRules}},
+\code{\linkS4class{AddDoubleRule}},
+\code{\linkS4class{MultDoubleRule}},
+\code{\link{createSR}},
+\code{\link{createDR}}
+
+}
+\examples{
+
+}
+\keyword{classes}
Modified: pkg/ruleR/man/IdenSingleRule-class.Rd
===================================================================
--- pkg/ruleR/man/IdenSingleRule-class.Rd 2012-10-16 10:05:15 UTC (rev 63)
+++ pkg/ruleR/man/IdenSingleRule-class.Rd 2012-10-16 18:46:31 UTC (rev 64)
@@ -1,54 +1,52 @@
-\name{IdenSingleRule-class}
-\Rdversion{1.1}
-\docType{class}
-\alias{IdenSingleRule-class}
-%\alias{calculateSpecific,IdenSingleRule,numeric,ANY-method}
-
-\title{Class \code{"IdenSingleRule"}}
-\description{
-A class for rules which return not modyfied input.
-Used mainly in \code{automaticTest} to define no futher operations.
-Objects of this class inherit from \code{SingleRule}.
-}
-\section{Objects from the Class}{
-Objects can be created by calls of the form \code{new("IdenSingleRule", ...)}.
-%% ~~ describe objects here ~~
-}
-\section{Slots}{
- \describe{
- \item{\code{previousRule}:}{Object of class \code{"SingleRule"} - a rule that will be executed before \code{IdenSingleRule} (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 = "IdenSingleRule", y = "numeric", z = "ANY")}: ... }
- }
-}
-\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{calculate}},
-\code{\linkS4class{SingleRule}},
-\code{\linkS4class{DoubleRule}},
-\code{\link{createSR}},
-\code{\link{createDR}}
-}
-\examples{
-m<-new("IdenSingleRule")
-print(m)
-}
-\keyword{classes}
+\name{IdenSingleRule-class}
+\Rdversion{1.1}
+\docType{class}
+\alias{IdenSingleRule-class}
+%\alias{calculateSpecific,IdenSingleRule,numeric,ANY-method}
+
+\title{Class \code{"IdenSingleRule"}}
+\description{
+A class for rules which do not modify input. This class can be seen as a basic building block. Objects of this class inherit from \code{SingleRule}.
+}
+\section{Objects from the Class}{
+Objects can be created by calls of the form \code{new("IdenSingleRule", ...)}.
+%% ~~ describe objects here ~~
+}
+\section{Slots}{
+ \describe{
+ \item{\code{previousRule}:}{Object of class \code{"SingleRule"} - a rule that will be executed before \code{IdenSingleRule} (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 = "IdenSingleRule", y = "numeric", z = "ANY")}: ... }
+ }
+}
+\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{calculate}},
+\code{\linkS4class{SingleRule}},
+\code{\linkS4class{DoubleRule}},
+\code{\link{createSR}},
+\code{\link{createDR}}
+}
+\examples{
+m<-new("IdenSingleRule")
+print(m)
+}
+\keyword{classes}
Modified: pkg/ruleR/man/MultConstSingleRule-class.Rd
===================================================================
--- pkg/ruleR/man/MultConstSingleRule-class.Rd 2012-10-16 10:05:15 UTC (rev 63)
+++ pkg/ruleR/man/MultConstSingleRule-class.Rd 2012-10-16 18:46:31 UTC (rev 64)
@@ -1,57 +1,56 @@
-\name{MultConstSingleRule-class}
-\Rdversion{1.1}
-\docType{class}
-\alias{MultConstSingleRule-class}
-%\alias{calculateSpecific,MultConstSingleRule,numeric,ANY-method}
-
-\title{Class \code{"MultConstSingleRule"}}
-\description{
-A class for rules which multiply previous element of numeric sequence by a specyfied constant.
- Objects of this class inherit from \code{SingleRule}.
-}
-\section{Objects from the Class}{
-Objects can be created by calls of the form \code{new("MultConstSingleRule", ...)}.
-%% ~~ 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{MultConstSingleRule} (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 = "MultConstSingleRule", y = "numeric", z = "ANY")}: ... }
- }
-}
-\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{calculate}},
-\code{\linkS4class{SingleRule}},
-\code{\linkS4class{DoubleRule}},
-\code{\link{createSR}},
-\code{\link{createDR}}
-}
-\examples{
-m<-new("MultConstSingleRule",constantVal=4,previousRule=new("IdenSingleRule")) #or m<-createSR(a1=3,cv1=4,n=0)
-print(m)
-
-calculate(m,50)#50*4=200
-
-}
-\keyword{classes}
+\name{MultConstSingleRule-class}
+\Rdversion{1.1}
+\docType{class}
+\alias{MultConstSingleRule-class}
+%\alias{calculateSpecific,MultConstSingleRule,numeric,ANY-method}
+
+\title{Class \code{"MultConstSingleRule"}}
+\description{
+A class for rules multiplying the previous element of numeric sequence by a constant. Objects of this class inherit from \code{SingleRule}.
+}
+\section{Objects from the Class}{
+Objects can be created by calls of the form \code{new("MultConstSingleRule", ...)}.
+%% ~~ describe objects here ~~
+}
+\section{Slots}{
+ \describe{
+ \item{\code{constantVal}:}{Object of class \code{"numeric"} - a constant that the previous element of the numeric sequence will be multiplied with}
+ \item{\code{previousRule}:}{Object of class \code{"SingleRule"} - a rule that will be executed before \code{MultConstSingleRule} (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 = "MultConstSingleRule", y = "numeric", z = "ANY")}: ... }
+ }
+}
+\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{calculate}},
+\code{\linkS4class{SingleRule}},
+\code{\linkS4class{DoubleRule}},
+\code{\link{createSR}},
+\code{\link{createDR}}
+}
+\examples{
+m<-new("MultConstSingleRule",constantVal=4,previousRule=new("IdenSingleRule")) #or m<-createSR(a1=3,cv1=4,n=0)
+print(m)
+
+calculate(m,50)#50*4=200
+
+}
+\keyword{classes}
Modified: pkg/ruleR/man/MultDoubleRule-class.Rd
===================================================================
--- pkg/ruleR/man/MultDoubleRule-class.Rd 2012-10-16 10:05:15 UTC (rev 63)
+++ pkg/ruleR/man/MultDoubleRule-class.Rd 2012-10-16 18:46:31 UTC (rev 64)
@@ -1,59 +1,59 @@
-\name{MultDoubleRule-class}
-\Rdversion{1.1}
-\docType{class}
-\alias{MultDoubleRule-class}
-%\alias{calculateSpecific,MultDoubleRule,numeric,numeric-method}
-
-\title{Class \code{"MultDoubleRule"}}
-\description{
-A class for rules multiplying two elements of numeric sequence.
-Objects of this class inherit from class \code{DoubleRule}.
-}
-\section{Objects from the Class}{
-Objects can be created by calls of the form \code{new("MultDoubleRule", ...)}.
-%% ~~ describe objects here ~~
-}
-\section{Slots}{
- \describe{
- \item{\code{firstRule}:}{Object of class \code{"SingleRule"} - \code{SingleRule} to be executed on the first element of numeric sequence (before the \code{DoubleRule}).This doesn't need to be specyfied.}
- \item{\code{secondRule}:}{Object of class \code{"SingleRule"} - \code{SingleRule} to be executed on the second element of numeric sequence (before the \code{DoubleRule}).This doesn't need to be specyfied. }
- \item{\code{nextSingle}:}{Object of class \code{"SingleRule"} - \code{SingleRule} to be executed on the result of \code{DoubleRule}. This doesn't need to be specyfied.}
- \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 = "MultDoubleRule", y = "numeric", z = "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{calculate}},
-\code{\linkS4class{DoubleRule}},
-\code{\linkS4class{SingleRule}},
-\code{\link{createSR}},
-\code{\link{createDR}}
-}
-\examples{
-
-m<-new("MultDoubleRule")
-print(m)
-
-calculate(m,20,9) #20*9=180
-
-}
-\keyword{classes}
+\name{MultDoubleRule-class}
+\Rdversion{1.1}
+\docType{class}
+\alias{MultDoubleRule-class}
+%\alias{calculateSpecific,MultDoubleRule,numeric,numeric-method}
+
+\title{Class \code{"MultDoubleRule"}}
+\description{
+A class for rules multiplying two elements of a numeric sequence.
+Objects of this class inherit from class \code{DoubleRule}.
+}
+\section{Objects from the Class}{
+Objects can be created by calls of the form \code{new("MultDoubleRule", ...)}.
+%% ~~ describe objects here ~~
+}
+\section{Slots}{
+ \describe{
+ \item{\code{firstRule}:}{Object of class \code{"SingleRule"} - \code{SingleRule} to be executed on the first element of numeric sequence (before the \code{DoubleRule}).This doesn't need to be specyfied.}
+ \item{\code{secondRule}:}{Object of class \code{"SingleRule"} - \code{SingleRule} to be executed on the second element of numeric sequence (before the \code{DoubleRule}).This doesn't need to be specyfied. }
+ \item{\code{nextSingle}:}{Object of class \code{"SingleRule"} - \code{SingleRule} to be executed on the result of \code{DoubleRule}. This doesn't need to be specyfied.}
+ \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 = "MultDoubleRule", y = "numeric", z = "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{calculate}},
+\code{\linkS4class{DoubleRule}},
+\code{\linkS4class{SingleRule}},
+\code{\link{createSR}},
+\code{\link{createDR}}
+}
+\examples{
+
+m<-new("MultDoubleRule")
+print(m)
+
+calculate(m,20,9) #20*9=180
+
+}
+\keyword{classes}
Modified: pkg/ruleR/man/SingleRule-class.Rd
===================================================================
--- pkg/ruleR/man/SingleRule-class.Rd 2012-10-16 10:05:15 UTC (rev 63)
+++ pkg/ruleR/man/SingleRule-class.Rd 2012-10-16 18:46:31 UTC (rev 64)
@@ -1,51 +1,51 @@
-\name{SingleRule-class}
-\Rdversion{1.1}
-\docType{class}
-\alias{SingleRule-class}
-%\alias{calculate,SingleRule,numeric,ANY-method}
-%\alias{calculateSpecific,SingleRule,numeric,ANY-method}
-
-\title{Class \code{"SingleRule"}}
-\description{
-rules operating on single argument
-}
-\section{Objects from the Class}{
-Objects can be created by calls of the form \code{new("SingleRule", ...)}.
-%% ~~ describe objects here ~~
-}
-\section{Slots}{
- \describe{
- \item{\code{previousRule}:}{Object of class \code{"SingleRule"} ~~ }
- \item{\code{.S3Class}:}{Object of class \code{"character"} ~~ }
- }
-}
-\section{Extends}{
-Class \code{"\linkS4class{Rule}"}, directly.
-}
-\section{Methods}{
- \describe{
- \item{calculate}{\code{signature(x = "SingleRule", y = "numeric", z = "ANY")}: ... }
- \item{calculateSpecific}{\code{signature(x = "SingleRule", y = "numeric", z = "ANY")}: ... }
- }
-}
-\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{~~fun~~}}, ~~~
-%% ~~or \code{\linkS4class{CLASSNAME}} for links to other classes ~~~
-}
-\examples{
-showClass("SingleRule")
-}
-\keyword{classes}
-\keyword{internal}
+\name{SingleRule-class}
+\Rdversion{1.1}
+\docType{class}
+\alias{SingleRule-class}
+%\alias{calculate,SingleRule,numeric,ANY-method}
+%\alias{calculateSpecific,SingleRule,numeric,ANY-method}
+
+\title{Class \code{"SingleRule"}}
+\description{
+rules operating on single arguments
+}
+\section{Objects from the Class}{
+Objects can be created by calls of the form \code{new("SingleRule", ...)}.
+%% ~~ describe objects here ~~
+}
+\section{Slots}{
+ \describe{
+ \item{\code{previousRule}:}{Object of class \code{"SingleRule"} ~~ }
+ \item{\code{.S3Class}:}{Object of class \code{"character"} ~~ }
+ }
+}
+\section{Extends}{
+Class \code{"\linkS4class{Rule}"}, directly.
+}
+\section{Methods}{
+ \describe{
+ \item{calculate}{\code{signature(x = "SingleRule", y = "numeric", z = "ANY")}: ... }
+ \item{calculateSpecific}{\code{signature(x = "SingleRule", y = "numeric", z = "ANY")}: ... }
+ }
+}
+\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{~~fun~~}}, ~~~
+%% ~~or \code{\linkS4class{CLASSNAME}} for links to other classes ~~~
+}
+\examples{
+showClass("SingleRule")
+}
+\keyword{classes}
+\keyword{internal}
Modified: pkg/ruleR/man/createSR.Rd
===================================================================
--- pkg/ruleR/man/createSR.Rd 2012-10-16 10:05:15 UTC (rev 63)
+++ pkg/ruleR/man/createSR.Rd 2012-10-16 18:46:31 UTC (rev 64)
@@ -1,62 +1,62 @@
-\name{createSR}
-\alias{createSR}
-%- Also NEED an '\alias' for EACH other topic documented here.
-\title{
-createSR
-}
-\description{
-A function to create objects of class \code{SingleRule}
-}
-\usage{
-createSR(a1 = NULL, cv1 = NULL, n = NULL, ...)
-}
-%- maybe also 'usage' for other objects documented here.
-\arguments{
- \item{a1}{
-is an index from table SingleRule (default a=NULL) //if 'a' is NULL it will be generated
-}
- \item{cv1}{
-is a constant value
-}
- \item{n}{
-how many rules are to be nested (default=NULL menas that I want to generate it automatically let's say from c(0,1,2)
-}
- \item{\dots}{
-if I would like to add some rules nested I can provide their parameters cv must be always supplied
-}
-}
-\details{
-%% ~~ If necessary, more details than the description above ~~
-}
-\value{
-%% ~Describe the value returned
-%% 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{
-createSR(a1=2,cv1=1,n=0)
-
-createSR(a1=2,cv1=4,n=1,c(2,15))
-
-}
-% Add one or more standard keywords, see file 'KEYWORDS' in the
-% R documentation directory.
-\keyword{ ~kwd1 }
-\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
+\name{createSR}
+\alias{createSR}
+%- Also NEED an '\alias' for EACH other topic documented here.
+\title{
+createSR
+}
+\description{
+A function to create objects of class \code{SingleRule}
+}
+\usage{
+createSR(a1 = NULL, cv1 = NULL, n = NULL, ...)
+}
+%- maybe also 'usage' for other objects documented here.
+\arguments{
+ \item{a1}{
+an index from table \code{SingleRule} (the default \code{NULL} leads to a randomly generated rule)
+}
+ \item{cv1}{
+ a constant value
+}
+ \item{n}{
+how many rules are to be nested? (the default \code{NULL} will randomly generate an \code{n} from \code{c(0,1,2)}
+}
+ \item{\dots}{
+parameters for nested rules can be passed via this argument
+}
+}
+\details{
+%% ~~ If necessary, more details than the description above ~~
+}
+\value{
+%% ~Describe the value returned
+%% 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{
+createSR(a1=2,cv1=1,n=0)
+
+createSR(a1=2,cv1=4,n=1,c(2,15))
+
+}
+% 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/createTest.Rd
===================================================================
--- pkg/ruleR/man/createTest.Rd 2012-10-16 10:05:15 UTC (rev 63)
+++ pkg/ruleR/man/createTest.Rd 2012-10-16 18:46:31 UTC (rev 64)
@@ -2,7 +2,7 @@
\alias{createTest}
%- Also NEED an '\alias' for EACH other topic documented here.
\title{
-A function to create a test with specified parameters.
+Create a test with specified parameters.
}
\description{
A function to a create test with specified parameters.
@@ -14,11 +14,11 @@
%- maybe also 'usage' for other objects documented here.
\arguments{
\item{n}{
-how many numeric sequences should be generated? (how long the test should be)
+how many numeric sequences should be generated?
}
\item{dictionary}{
-a list of all rules that can be used in generating a test. Every element of this list should be an object of class \code{DictionaryRule}. \cr
-By default dictionary is a \code{basicDictionary} list but such list can be easily created by user.
+a list of all rules that can be used when generating the test. Every element of this list should be an object of class \code{DictionaryRule}. \cr
+By default dictionary is a \code{basicDictionary} list but such list can be created by the user.
}
\item{start}{
a vector specifying the allowed range for starting values. Default range is 1:100
@@ -155,5 +155,5 @@
}
% Add one or more standard keywords, see file 'KEYWORDS' in the
% R documentation directory.
-\keyword{ ~kwd1 }
-\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
+%\keyword{ ~kwd1 }
+%\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
Modified: pkg/ruleR/man/digits.Rd
===================================================================
--- pkg/ruleR/man/digits.Rd 2012-10-16 10:05:15 UTC (rev 63)
+++ pkg/ruleR/man/digits.Rd 2012-10-16 18:46:31 UTC (rev 64)
@@ -1,53 +1,54 @@
-\name{digits}
-\alias{digits}
-%- Also NEED an '\alias' for EACH other topic documented here.
-\title{
-a function to separate digits from a number
-}
-\description{
-That is a function to separate digits from a number.
-This function is used in \code{DigSumSingleRule}, which calculates the sum of digits.
-}
-\usage{
-digits(x)
-}
-%- maybe also 'usage' for other objects documented here.
-\arguments{
- \item{x}{
-numeric value of which digits are separated
-}
-}
-\details{
-%% ~~ If necessary, more details than the description above ~~
-}
-\value{
-%% ~Describe the value returned
-%% If it is a LIST, use
-%% \item{comp1 }{Description of 'comp1'}
-%% \item{comp2 }{Description of 'comp2'}
-%% ...
-}
-\references{
-https://stat.ethz.ch/pipermail/r-help/2011-March/270786.html
-}
-\author{
-%% ~~who you are~~
-}
-\note{
-%% ~~further notes~~
-}
-
-%% ~Make other sections like Warning with \section{Warning }{....} ~
-
-\seealso{
-\code{\linkS4class{DigSumSingleRule}}
-}
-\examples{
-m<-digits(46)
-m[1]#4
-m[2]#6
-}
-% Add one or more standard keywords, see file 'KEYWORDS' in the
-% R documentation directory.
-\keyword{ ~kwd1 }
-\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
+\name{digits}
+\alias{digits}
+%- Also NEED an '\alias' for EACH other topic documented here.
+\title{
+a function to separate digits from a number
+}
+\description{
+That is a function to separate digits from a number.
+This function is used in \code{DigSumSingleRule}, which calculates the sum of digits.
+}
+\usage{
+digits(x)
+}
+%- maybe also 'usage' for other objects documented here.
+\arguments{
+ \item{x}{
+numeric value of which digits are separated
+}
+}
+\details{
+%% ~~ If necessary, more details than the description above ~~
+}
+\value{
+A vector which contains the digits if the number (in base 10).
+%% ~Describe the value returned
+%% If it is a LIST, use
+%% \item{comp1 }{Description of 'comp1'}
+%% \item{comp2 }{Description of 'comp2'}
+%% ...
+}
+\references{
+https://stat.ethz.ch/pipermail/r-help/2011-March/270786.html
+}
+\author{
+%% ~~who you are~~
+}
+\note{
+%% ~~further notes~~
+}
+
+%% ~Make other sections like Warning with \section{Warning }{....} ~
+
+\seealso{
+\code{\linkS4class{DigSumSingleRule}}
+}
+\examples{
+m<-digits(46)
+m[1]#4
+m[2]#6
+}
+% 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/doubleRules.Rd
===================================================================
--- pkg/ruleR/man/doubleRules.Rd 2012-10-16 10:05:15 UTC (rev 63)
+++ pkg/ruleR/man/doubleRules.Rd 2012-10-16 18:46:31 UTC (rev 64)
@@ -2,12 +2,11 @@
\alias{doubleRules}
\docType{data}
\title{
-list of available basic \code{DoubleRule}s
+A list of available basic \code{DoubleRule}s
}
\description{
-A list of basic \code{DoubleRule}'s implemented in ruleR.
-Refering to the index of rules on this list, combining rules is executed.
-Only names of the rules are stored on the list.
+A list of basic \code{DoubleRule}s implemented in \code{ruleR}.
+Some functions use this list when (randomly) generating rules and tests. Only the names of the rules are stored on the list. Changing \code{DoubleRules} changes the behaviour of \code{\link{createSR}},\code{\link{createDR}} and \code{\link{createTest}}
}
Modified: pkg/ruleR/man/duplicate.Rd
===================================================================
[TRUNCATED]
To get the complete diff run:
svnlook diff /svnroot/ruler -r 64
More information about the Ruler-commits
mailing list