[Ruler-commits] r38 - pkg/ruleR/man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Tue Aug 21 09:47:24 CEST 2012
Author: doebler
Date: 2012-08-21 09:47:23 +0200 (Tue, 21 Aug 2012)
New Revision: 38
Modified:
pkg/ruleR/man/AddConstSingleRule-class.Rd
pkg/ruleR/man/AddDoubleRule-class.Rd
pkg/ruleR/man/AddRule.Rd
pkg/ruleR/man/automaticTest.Rd
Log:
Spelling ...
Modified: pkg/ruleR/man/AddConstSingleRule-class.Rd
===================================================================
--- pkg/ruleR/man/AddConstSingleRule-class.Rd 2012-08-21 07:38:17 UTC (rev 37)
+++ pkg/ruleR/man/AddConstSingleRule-class.Rd 2012-08-21 07:47:23 UTC (rev 38)
@@ -1,68 +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 specyfied 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{
-%% ~~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{
-##[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}
+\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) #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-08-21 07:38:17 UTC (rev 37)
+++ pkg/ruleR/man/AddDoubleRule-class.Rd 2012-08-21 07:47:23 UTC (rev 38)
@@ -1,87 +1,86 @@
-\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 rule which adds two prevous elements of numeric 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 specyfied)}
- \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 specyfied) }
- \item{\code{nextSingle}:}{Object of class \code{"SingleRule"} - a rule to be executed on the result of DoubleRule (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 = "AddDoubleRule", 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{
-
-#[1] simple DoubleRule
-
-p<-new("AddDoubleRule")
-calculate(p,12,5) #12+5=17
-
-
-
-#[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}
+\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")
+# 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/AddRule.Rd
===================================================================
--- pkg/ruleR/man/AddRule.Rd 2012-08-21 07:38:17 UTC (rev 37)
+++ pkg/ruleR/man/AddRule.Rd 2012-08-21 07:47:23 UTC (rev 38)
@@ -1,67 +1,66 @@
-\name{AddRule}
-\alias{AddRule}
-%- Also NEED an '\alias' for EACH other topic documented here.
-\title{
-function to add rules specyfied by user to a list
-}
-\description{
-
-When creating test items test rules can be either combined automatically or
-be generated from the set of rules defined by user (stored on \code{MyRule} list).
-\code{AddRule} is a function to add a rule defined by a user to \code{MyRule} list.
-
-}
-\usage{
-AddRule(rule)
-}
-%- maybe also 'usage' for other objects documented here.
-\arguments{
- \item{rule}{
- argument \code{rule} must inherit either form class \code{"SingleRule"} or \code{"DoubleRule"}.
-}
-}
-\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{
-\code{\link{automaticTest}},
-\code{\link{MyRules}},
-\code{\link{createSR}},
-\code{\link{createDR}}
-
-}
-\examples{
-
-# 'MyRules' list by default consists only of one element, which is NA.
-
-
-# creating sample rules (this should be done by user)
-n<-new("SubsDoubleRule")
-p<-new("AddConstSingleRule", constantVal=6)
-
-AddRule(n) #"Your rule succesfully added tp 'MyRule' list"
-AddRule(p) #"Your rule succesfully added tp 'MyRule' list"
-AddRule(n)# Error in AddRule(n) : There already is a rule that gives the same result.
-
-}
-
-\keyword{AddRule}
+\name{AddRule}
+\alias{AddRule}
+%- Also NEED an '\alias' for EACH other topic documented here.
+\title{
+Add rules specified by user to a list
+}
+\description{
+When creating test items test rules can be either combined automatically or
+be generated from the set of rules defined by user (stored on \code{MyRule} list).
+\code{AddRule} is a function to add a rule defined by a user to \code{MyRule} list.
+
+}
+\usage{
+AddRule(rule)
+}
+%- maybe also 'usage' for other objects documented here.
+\arguments{
+ \item{rule}{
+ argument \code{rule} must inherit either form class \code{"SingleRule"} or \code{"DoubleRule"}.
+}
+}
+\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{
+\code{\link{automaticTest}},
+\code{\link{MyRules}},
+\code{\link{createSR}},
+\code{\link{createDR}}
+
+}
+\examples{
+
+# 'MyRules' list by default consists only of one element, which is NA.
+
+
+# creating sample rules (this should be done by user)
+n<-new("SubsDoubleRule")
+p<-new("AddConstSingleRule", constantVal=6)
+
+AddRule(n) #"Your rule succesfully added tp 'MyRule' list"
+AddRule(p) #"Your rule succesfully added tp 'MyRule' list"
+AddRule(n)# Error in AddRule(n) : There already is a rule that gives the same result.
+
+}
+
+\keyword{AddRule}
Modified: pkg/ruleR/man/automaticTest.Rd
===================================================================
--- pkg/ruleR/man/automaticTest.Rd 2012-08-21 07:38:17 UTC (rev 37)
+++ pkg/ruleR/man/automaticTest.Rd 2012-08-21 07:47:23 UTC (rev 38)
@@ -1,82 +1,82 @@
-\name{automaticTest}
-\alias{automaticTest}
-%- Also NEED an '\alias' for EACH other topic documented here.
-\title{
-function to generate test with specyfied characteristics
-}
-\description{
-Function to generate desired amount of test items (numeric sequence of specyfied length).
-Items can be created using automatically combined rules, or using only the
-rules specyfied by the user (stored on \code{MyRules} list).
-Function /code{automaticTest}is also checking the uniqueness of generated sequences and prevents constat sequences
-to be generated.
-For every numeric sequence \code{automaticTest} returns the list of rules used to create it
-as well as 'noise' answers (in case muliple choice is needed in the test)
-}
-\usage{
-automaticTest(testlen, type = 1, seqlen = 6)
-}
-%- maybe also 'usage' for other objects documented here.
-\arguments{
- \item{testlen}{
-- how many numeric sequences (test items) are to be generated
-}
- \item{type}{
-- which rules to be applied. \code{type=1} means that the rules are generated automatically,
-\code{type=2} means that ony rules defined by user (stored on \code{MyRules} list) should be used
- to create a sequence. By default \code{type=1}.
-}
- \item{seqlen}{
- - desired length of numeric sequence (by default \code{seqlen=6})
-}
-}
-\details{
-%% ~~ If necessary, more details than the description above ~~
-}
-\value{
-\code{automaticTest} function returns a list containing the following:
-
-\item{$items}{generated numeric sequences (in case multiple answer format is needed in a test)}
-\item{$noise }{noise 'answers' }
-\item{$rules}{a list of rules used to generate numeric sequences}
-
-}
-\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{
-
-#[1] everything generated automatically
-m<-automaticTest(10) # type=1, seqlen=6
-m$items # generated numeric sequences
-m$noise # sample noise answers
-m$rules # list of rules used to create items
-
-
-#[2] items generated only with the rules supplied by user
-m<-new("AddConstSingleRule", constantVal=6) #single rule adding 6 to an element of sequence
-r<-new("AddConstSingleRule", constantVal=10)#single rule adding 10 to an element of sequence
-AddRule(m) #adding rule 'm' to 'MyRules' list
-AddRule(r) # adding rule 'r' to 'MyRules' list
-m<-automaticTest(10,type=2 # generating a test consisting of 10 items, with rules 'm' and 'r' only
-m$items # generated numeric sequences
-m$rules # list of rules used to create items
-m$noise # sample noise answers
-
-}
-% Add one or more standard keywords, see file 'KEYWORDS' in the
-% R documentation directory.
-\keyword{ automaticTest }
-
+\name{automaticTest}
+\alias{automaticTest}
+%- Also NEED an '\alias' for EACH other topic documented here.
+\title{
+Generate test with specified characteristics
+}
+\description{
+Function to generate a desired amount of test items (numeric sequence of specified length).
+Items can be created using automatically combined rules, or using only the
+rules specified by the user (stored on \code{MyRules} list).
+Function \code{automaticTest} is also checking the uniqueness of generated sequences and prevents constat sequences
+to be generated.
+For every numeric sequence \code{automaticTest} returns the list of rules used to create it
+as well as 'noise' answers (distractors) in case muliple choice is needed in the test.
+}
+\usage{
+automaticTest(testlen, type = 1, seqlen = 6)
+}
+%- maybe also 'usage' for other objects documented here.
+\arguments{
+ \item{testlen}{
+- how many numeric sequences (test items) are to be generated
+}
+ \item{type}{
+- which rules to be applied. \code{type=1} means that the rules are generated automatically,
+\code{type=2} means that ony rules defined by user (stored on \code{MyRules} list) should be used
+ to create a sequence. By default \code{type=1}.
+}
+ \item{seqlen}{
+ - desired length of numeric sequence (by default \code{seqlen=6})
+}
+}
+\details{
+%% ~~ If necessary, more details than the description above ~~
+}
+\value{
+\code{automaticTest} function returns a list containing the following:
+
+\item{$items}{generated numeric sequences (in case multiple answer format is needed in a test)}
+\item{$noise }{noise 'answers' }
+\item{$rules}{a list of rules used to generate numeric sequences}
+
+}
+\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{
+
+#[1] everything generated automatically
+m<-automaticTest(10) # type=1, seqlen=6
+m$items # generated numeric sequences
+m$noise # sample noise answers
+m$rules # list of rules used to create items
+
+
+#[2] items generated only with the rules supplied by user
+m<-new("AddConstSingleRule", constantVal=6) #single rule adding 6 to an element of sequence
+r<-new("AddConstSingleRule", constantVal=10)#single rule adding 10 to an element of sequence
+AddRule(m) #adding rule 'm' to 'MyRules' list
+AddRule(r) # adding rule 'r' to 'MyRules' list
+m<-automaticTest(10,type=2 # generating a test consisting of 10 items, with rules 'm' and 'r' only
+m$items # generated numeric sequences
+m$rules # list of rules used to create items
+m$noise # sample noise answers
+
+}
+% Add one or more standard keywords, see file 'KEYWORDS' in the
+% R documentation directory.
+\keyword{ automaticTest }
+
More information about the Ruler-commits
mailing list