[Ruler-commits] r55 - in pkg/ruleR: R inst/doc man

noreply at r-forge.r-project.org noreply at r-forge.r-project.org
Tue Oct 9 11:21:09 CEST 2012


Author: doebler
Date: 2012-10-09 11:21:09 +0200 (Tue, 09 Oct 2012)
New Revision: 55

Modified:
   pkg/ruleR/R/ruleR_upgraded_final.R
   pkg/ruleR/inst/doc/ruleR.Rnw
   pkg/ruleR/inst/doc/ruleR.bib
   pkg/ruleR/man/doubleRules.Rd
   pkg/ruleR/man/extract_double_comment.Rd
   pkg/ruleR/man/ruleR-package.Rd
   pkg/ruleR/man/sequenceR.Rd
Log:
Added random argument to sequenceR which defaults to TRUE to be able to calculate some sequences without using createTest, changed doc

Modified: pkg/ruleR/R/ruleR_upgraded_final.R
===================================================================
--- pkg/ruleR/R/ruleR_upgraded_final.R	2012-10-08 15:18:23 UTC (rev 54)
+++ pkg/ruleR/R/ruleR_upgraded_final.R	2012-10-09 09:21:09 UTC (rev 55)
@@ -292,7 +292,7 @@
 #'ns' nextSingle argument of an object of class doubleRule
 #'
 createDR<-function(a=NULL,fr=NULL,sr=NULL,ns=NULL){
-                    if(!is.null(a) && a>length(doubleRules)) stop (paste("The list of doublrRules is shoreter than ",a, ".Please specify 'a' value, which is smaller than or equal to",length(doubleRules)))
+                    if(!is.null(a) && a>length(doubleRules)) stop (paste("The list of doubleRules is shorter than ",a, ".Please specify 'a' value, which is smaller than or equal to",length(doubleRules)))
                     if(!inherits(fr,"SingleRule") && !is.null(fr))stop(paste("'fr' argument must inherit from class singleRule"))
                     if(!inherits(sr,"SingleRule") && !is.null(sr))stop(paste("'sr' argument must inherit from class singleRule"))
                     if(!inherits(ns,"SingleRule") && !is.null(ns))stop(paste("'ns' argument must inherit from class singleRule"))
@@ -319,15 +319,21 @@
 #A FUNCTION TO GENERATE NUMERIC SEQUENCE OF DECLARED LENGTH
 # 'seqlen' is the length of the numeric sequence (default value is 6)
 # 'start' - range from which starting values are generated
-sequenceR<-function(start,rule,seqlen){
+sequenceR<-function(start,rule,seqlen, random = TRUE){
                                   if(seqlen<4) stop("sequence must be longer than 4")
                                   
                                   
                                   if(length(start)==1){ #generating starting elements of numeric sequence
                                     x1<-start;x2<-start
-                                  }else{start<-sample(start,2)
+                                  }else{
+                                    if(random){
+                                    start<-sample(start,2)
                                         x1<-start[1]
                                         x2<-start[2]
+                                    }else{
+                                      x1<-start[1]
+                                      x2<-start[2]
+                                    }
                                   }
                                   
                                   
@@ -355,7 +361,6 @@
 
 
 
-
  
 # checking if a vector is in any row of the matrix
 #'mx' is a matrix in which I am searching

Modified: pkg/ruleR/inst/doc/ruleR.Rnw
===================================================================
--- pkg/ruleR/inst/doc/ruleR.Rnw	2012-10-08 15:18:23 UTC (rev 54)
+++ pkg/ruleR/inst/doc/ruleR.Rnw	2012-10-09 09:21:09 UTC (rev 55)
@@ -91,7 +91,7 @@
 
 \begin{table}
  \begin{center}
-  \caption{Some radicals and possible combinations}\label{tab:radicals}
+  \caption{Some radicals and som possible combinations}\label{tab:radicals}
   \begin{tabular}{lcc}
    \toprule
    radical                         & arity & term\\ \midrule
@@ -190,16 +190,51 @@
 
 
 \subsection{Using \texttt{ruleR} to generate number sequence items}
+We show how to use \texttt{ruleR} in an interactive R session, assuming that readers know some basic R. The \texttt{ruleR} package does intentionally not hide all traces of S4 classes, since it is expected users will want to write their own extensions. Good starting points to learn about S4 classes are \cite{chambers2006how} or the vignette of the \texttt{Brobdingnag} package \cite{brob}, but we will try to be fairly detailed.
 
+Since you are reading this document, you probably have already obtained \texttt{ruleR}. The most recent (development) version is available from R-forge at \url{http://r-forge.r-project.org/projects/ruler/} and can be installed in an interactive R session by typing
+<<eval=FALSE>>=
+install.packages("ruleR", repos="http://R-Forge.R-project.org")
+@
+More stable versions are available via CRAN. As usual we load the package by
+<<>>=
+library(ruleR)
+@
+If you get stuck, you might try
+<<>>=
+help(ruleR)
+@
+Some rules for number sequences only need the current element to calculate the next, while others like the Fibonacci rule need the previous two elements. For this reason \texttt{ruleR} knows \emph{single rules} and \emph{double rules}. Let's have a look at the \texttt{list} of single rules
+<<>>=
+singleRules
+@
+and double rules
+<<>>=
+doubleRules
+@
+Not that many, but remember we can assemble new rules from these radicals. Before doing that, we define some basic building blocks by
+<<>>=
+idrule <- new("IdenSingleRule")
+add5 <- new("AddConstSingleRule", constantVal = 5, previousRule = idrule)
+mult2 <- new("MultConstSingleRule", constantVal = 2, previousRule = idrule)
+neg <- new("MultConstSingleRule", constantVal = -1, previousRule = idrule)
+DS <- new("DigSumSingleRule")
+@
+We can already calculate with these rules:
+<<>>=
+calculate(add5, 11)
+@
 
+\subsubsection{Combining single rules}
+Figure \ref{combsingle} shows how 
 
-%\section{Matrix items}
-
-
 \section{Further development of \texttt{ruleR}}
 
 Mention matrix items.
 
+The \texttt{ruleR} package can be used as a back-end in a computerized testing system. 
+
+
 The tree structure provided by \texttt{ruleR} might seem overly complex at first glance, but they are well-suited for a later cognitive analysis of items and RIG.
 
 

Modified: pkg/ruleR/inst/doc/ruleR.bib
===================================================================
--- pkg/ruleR/inst/doc/ruleR.bib	2012-10-08 15:18:23 UTC (rev 54)
+++ pkg/ruleR/inst/doc/ruleR.bib	2012-10-09 09:21:09 UTC (rev 55)
@@ -200,3 +200,18 @@
   publisher={Springer}
 }
 
+ at misc{chambers2006how,
+title={How S4 methods work},
+author={John Chambers},
+year={2006},
+howpublished={available on CRAN}
+}
+
+
+ at Manual{brob,
+    title = {Brobdingnag: Very large numbers in R},
+    author = {Robin K. S. Hankin},
+    year = {2011},
+    note = {R package version 1.2-1},
+    url = {http://CRAN.R-project.org/package=Brobdingnag},
+  }
\ No newline at end of file

Modified: pkg/ruleR/man/doubleRules.Rd
===================================================================
--- pkg/ruleR/man/doubleRules.Rd	2012-10-08 15:18:23 UTC (rev 54)
+++ pkg/ruleR/man/doubleRules.Rd	2012-10-09 09:21:09 UTC (rev 55)
@@ -1,50 +1,50 @@
-\name{doubleRules}
-\alias{doubleRules}
-\docType{data}
-\title{
-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.
-}
-
-
-%- maybe also 'usage' for other objects documented here.
-
-\arguments{
-  \item{doubleRules[1]}{
-"AddDoubleRule"
-}
-  \item{doubleRules[2]}{
-"MultDoubleRule"
-}
-  \item{doubleRules[3]}{
-"SubsDoubleRule"
-}
-  \item{doubleRules[4]}{
-"DivDoubleRule"
-}
-  \item{doubleRules[5]}{
-"ModuloDoubleRule"
-}
-  \item{doubleRules[6]}{
-"ExpDoubleRule"
-}
-
-}
-
-\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{
-doubleRules
-}
-\keyword{datasets}
+\name{doubleRules}
+\alias{doubleRules}
+\docType{data}
+\title{
+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.
+}
+
+
+%- maybe also 'usage' for other objects documented here.
+
+\arguments{
+  \item{doubleRules[1]}{
+"AddDoubleRule"
+}
+  \item{doubleRules[2]}{
+"MultDoubleRule"
+}
+%  \item{doubleRules[3]}{
+%"SubsDoubleRule"
+%}
+%  \item{doubleRules[4]}{
+%"DivDoubleRule"
+%}
+%  \item{doubleRules[5]}{
+%"ModuloDoubleRule"
+%}
+%  \item{doubleRules[6]}{
+%"ExpDoubleRule"
+%}
+
+}
+
+\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{
+doubleRules
+}
+\keyword{datasets}

Modified: pkg/ruleR/man/extract_double_comment.Rd
===================================================================
--- pkg/ruleR/man/extract_double_comment.Rd	2012-10-08 15:18:23 UTC (rev 54)
+++ pkg/ruleR/man/extract_double_comment.Rd	2012-10-09 09:21:09 UTC (rev 55)
@@ -1,58 +1,58 @@
-\name{extract_double_comment}
-\alias{extract_double_comment}
-%- Also NEED an '\alias' for EACH other topic documented here.
-\title{
-extract_double_commen
-}
-\description{
-A function to print double argument rules in common language.
-}
-\usage{
-extract_double_comment(x)
-}
-%- maybe also 'usage' for other objects documented here.
-\arguments{
-  \item{x}{
-is an object of class \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{\linkS4class{SingleRule}},
-\code{\linkS4class{DoubleRule}},
-\code{\link{extract_single_comment}},
-\code{\link{createTest}}
-
-}
-\examples{
-
-b<-createTest(1,chain=0,exact=4,del=0)
-extract_double_comment(b[[2]][[1]])
-
-  
-}
-% Add one or more standard keywords, see file 'KEYWORDS' in the
-% R documentation directory.
-\keyword{ ~kwd1 }
-\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
+\name{extract_double_comment}
+\alias{extract_double_comment}
+%- Also NEED an '\alias' for EACH other topic documented here.
+\title{
+extract_double_comment
+}
+\description{
+A function to print double argument rules in common language.
+}
+\usage{
+extract_double_comment(x)
+}
+%- maybe also 'usage' for other objects documented here.
+\arguments{
+  \item{x}{
+is an object of class \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{\linkS4class{SingleRule}},
+\code{\linkS4class{DoubleRule}},
+\code{\link{extract_single_comment}},
+\code{\link{createTest}}
+
+}
+\examples{
+
+b<-createTest(1,chain=0,exact=4,del=0)
+extract_double_comment(b[[2]][[1]])
+
+  
+}
+% 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/ruleR-package.Rd
===================================================================
--- pkg/ruleR/man/ruleR-package.Rd	2012-10-08 15:18:23 UTC (rev 54)
+++ pkg/ruleR/man/ruleR-package.Rd	2012-10-09 09:21:09 UTC (rev 55)
@@ -1,110 +1,109 @@
-\name{ruleR-package}
-\alias{ruleR-package}
-\alias{ruleR}
-\docType{package}
-\title{
-ruleR: An R package for rule based item generation
-}
-\description{
-The package generates numeric sequences items for intelligence tests.
-Items can be generated  using either the rules specified by user or random combination of 
-implemented rules.\cr\cr
-Parameters of the items such as:\cr
-- starting value(s),\cr 
-- maximum and minimum allowed elements,\cr
-- rules allowed to create items,\cr
-- number of nesting allowed (the length of chain of rules),\cr
-- length of numeric sequences\cr
-can be specyfied by user. 
-
-\code{ruleR} 
-
-
-
-
-}
-\details{
-\tabular{ll}{
-Package: \tab ruleR\cr
-Type: \tab Package\cr
-Version: \tab 1.0\cr
-Date: \tab 2012-07-31\cr
-License: \tab GPL-2\cr
-Depends: \tab methods\cr
-}
-%~~ An overview of how to use the package, including the most important functions ~~
-}
-\author{
-Maria Rafalak, Philipp Doebler\cr
-Maintainer: Maria Rafalak <m.rafalak at practest.com.pl>
-}
-\references{
-%~~ Literature or other references for background information ~~
-}
-
-\keyword{ package }
-\seealso{
-\code{\link{createTest}}
-%~~ Optional links to other man pages, e.g. ~~
-%~~ \code{\link[<pkg>:<pkg>-package]{<pkg>}} ~~
-}
-\examples{
-##[1] CREATING SIMPLE SINGLE OR DOUBLE RULES
-
-# single rules (operating on the previous element of the number sequence)
-ruleS1<-createSR(a1=2,cv1=14,n=0) # or: ruleS1<-new("AddConstSingleRule",constantVal=14)
-print(ruleS1)
-ruleS2<-createSR(a1=3,cv=0,n=0) #or: ruleS2<-new("DigSumSingleRule")
-print(ruleS2)
-s<-createSR(a1=1,cv=0,n=0) #or: s<-new("IdenSingleRule")
-print(s)
-
-# double rules (operating on the two previous elements of the number sequence)
-ruleD1<-createDR(a=2, fr=s,sr=s,ns=s) #or: ruleD1<-new("MultDoubleRule")
-print(ruleD1)
-ruleD2<-createDR(a=1,fr=s,sr=s,ns=s) #or: ruleD2<-new("AddDoubleRule")
-print(ruleD2)
-
-##[2] NESTING SEVERAL RULES
-
-combine1<-createSR(a1=2,cv1=14,n=2,3,2,2,0)
-print(combine1)
-
-combine2<-createDR(a=1,fr=combine1,sr=s,ns=ruleS1)
-print(combine2)
-
-##[3] CALCULATING WITH THE RULES
-
-calculate(ruleS1,2) # 2+14=16
-calculate(ruleS1,2,7)#2+14=16 // second argument is ignored because ruleS1 is a SingleRule
-
-calculate(ruleS2,67)#6+7=13
-calculate(ruleS2,67,45)#6+7=13 // second argument is ignored because ruleS2 is a SingleRule
-
-calculate(ruleD1,4,17)#4*17=68
-calculate(ruleD1,4) #4 //just returning the first argument
-
-calculate(ruleD2,5,17)#5+17=22
-calculate(ruleD1,5) #5 //just returning the first argument
-
-calculate(combine1,12)# (1+2)*2+14=20
-
-calculate(combine2,15,1) #41 
-# operations on first element: (1+5)*2+14=26
-# operations on second element: 1
-# DoubleRule calculated on the results: 26+1=27
-# next SingleRule calculated on the reult: 27+14=41
-
-
-##[4] CREATING A TEST CONSISTING OF 10 ITEMS
-m<-createTest(10)#all parameters default
-
-#printing rules used to create an item
-for(i in 1:length(m[[2]])){
-    cat(paste("\n\n--------------","rule for item number",i,"-------------\n"))
-    print.Rule(m[[2]][[i]])
-                          }
-## SEE \code{createTest} function for more detail
-
-
-                          
+\name{ruleR-package}
+\alias{ruleR-package}
+\alias{ruleR}
+\docType{package}
+\title{
+ruleR: An R package for rule based item generation
+}
+\description{
+The package generates numeric sequences items for intelligence tests.
+Items can be generated  using either the rules specified by user or random combination of 
+implemented rules.\cr\cr
+Parameters of the items such as:\cr
+- starting value(s),\cr 
+- maximum and minimum allowed elements,\cr
+- rules allowed to create items,\cr
+- number of nesting allowed (the length of chain of rules),\cr
+- length of numeric sequences\cr
+can be specyfied by user. 
+
+\code{ruleR} 
+
+
+
+
+}
+\details{
+\tabular{ll}{
+Package: \tab ruleR\cr
+Type: \tab Package\cr
+Version: \tab 1.0\cr
+Date: \tab 2012-07-31\cr
+License: \tab GPL-2\cr
+Depends: \tab methods\cr
+}
+%~~ An overview of how to use the package, including the most important functions ~~
+}
+\author{
+Maria Rafalak, Philipp Doebler\cr
+Maintainer: Maria Rafalak <m.rafalak at practest.com.pl>
+}
+\references{
+%~~ Literature or other references for background information ~~
+}
+
+\keyword{ package }
+\seealso{
+\code{\link{createTest}}
+%~~ Optional links to other man pages, e.g. ~~
+%~~ \code{\link[<pkg>:<pkg>-package]{<pkg>}} ~~
+}
+\examples{
+##[1] CREATING SIMPLE SINGLE OR DOUBLE RULES
+
+# single rules (operating on the previous element of the number sequence)
+ruleS1<-createSR(a1=2,cv1=14,n=0) # or: ruleS1<-new("AddConstSingleRule",constantVal=14)
+print(ruleS1)
+ruleS2<-createSR(a1=3,cv=0,n=0) #or: ruleS2<-new("DigSumSingleRule")
+print(ruleS2)
+s<-createSR(a1=1,cv=0,n=0) #or: s<-new("IdenSingleRule")
+print(s)
+
+# double rules (operating on the two previous elements of the number sequence)
+ruleD1<-createDR(a=2, fr=s,sr=s,ns=s) #or: ruleD1<-new("MultDoubleRule")
+print(ruleD1)
+ruleD2<-createDR(a=1,fr=s,sr=s,ns=s) #or: ruleD2<-new("AddDoubleRule")
+print(ruleD2)
+
+##[2] NESTING SEVERAL RULES
+
+combine1<-createSR(a1=2,cv1=14,n=2,3,2,2,0)
+print(combine1)
+
+combine2<-createDR(a=1,fr=combine1,sr=s,ns=ruleS1)
+print(combine2)
+
+##[3] CALCULATING WITH THE RULES
+
+calculate(ruleS1,2) # 2+14=16
+calculate(ruleS1,2,7)#2+14=16 // second argument is ignored because ruleS1 is a SingleRule
+
+calculate(ruleS2,67)#6+7=13
+calculate(ruleS2,67,45)#6+7=13 // second argument is ignored because ruleS2 is a SingleRule
+
+calculate(ruleD1,4,17)#4*17=68
+calculate(ruleD1,4) #4 //just returning the first argument
+
+calculate(ruleD2,5,17)#5+17=22
+calculate(ruleD1,5) #5 //just returning the first argument
+
+calculate(combine1,12)# (1+2)*2+14=20
+
+calculate(combine2,15,1) #41 
+# operations on first element: (1+5)*2+14=26
+# operations on second element: 1
+# DoubleRule calculated on the results: 26+1=27
+# next SingleRule calculated on the reult: 27+14=41
+
+
+##[4] CREATING A TEST CONSISTING OF 10 ITEMS
+m<-createTest(10)#all parameters default
+
+#printing rules used to create an item
+for(i in 1:length(m[[2]])){
+    cat(paste("\n\n--------------","rule for item number",i,"-------------\n"))
+    print.Rule(m[[2]][[i]])
+                          }
+## SEE \code{createTest} function for more detail
+
+}
\ No newline at end of file

Modified: pkg/ruleR/man/sequenceR.Rd
===================================================================
--- pkg/ruleR/man/sequenceR.Rd	2012-10-08 15:18:23 UTC (rev 54)
+++ pkg/ruleR/man/sequenceR.Rd	2012-10-09 09:21:09 UTC (rev 55)
@@ -1,65 +1,68 @@
-\name{sequenceR}
-\alias{sequenceR}
-%- Also NEED an '\alias' for EACH other topic documented here.
-\title{
-function
-}
-\description{
-A function to generate numeric sequence of specyfied lenght.
-Is used in \code{automaticTest} but can be used separately.
-Note that this function doesn't check for constant sequence or
-too big/small elements in numeric sequence!
-}
-\usage{
-sequenceR(start,rule,seqlen)
-}
-%- maybe also 'usage' for other objects documented here.
-\arguments{
-  \item{start}{
-range from which starting values are generated
-}
-  \item{rule}{
-rule that is to be used to generate numeric sequence
-}
-  \item{seqlen}{
-the length of the numeric sequence (default value is 6)
-}
-
-}
-\details{
-%%  ~~ If necessary, more details than the description above ~~
-}
-\value{
-function returns a list containing of:
-
-\item{sequenceR[[1]] }{numeric sequence as a list}
-\item{sequenceR[[2]]}{rule used to generate the sequence}
-
-}
-\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{conCheck}},
-\code{\link{check}},
-\code{\link{createSR}},
-\code{\link{createDR}}
-
-}
-\examples{
-sequenceR(rule=new("AddConstSingleRule",constantVal=1,previousRule=new("IdenSingleRule")),start=99,seqlen=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{sequenceR}
+\alias{sequenceR}
+%- Also NEED an '\alias' for EACH other topic documented here.
+\title{
+function
+}
+\description{
+A function to generate numeric sequence of specified length.
+Is used in \code{\link{createTest}} but can be used separately.
+Note that this function doesn't check for constant sequences or
+too big/small elements in numeric sequence!
+}
+\usage{
+sequenceR(start, rule, seqlen, random = TRUE)
+}
+%- maybe also 'usage' for other objects documented here.
+\arguments{
+  \item{start}{
+vector from which starting values are generated
+}
+  \item{rule}{
+rule that is to be used to generate numeric sequence
+}
+  \item{seqlen}{
+the length of the numeric sequence (default value is 6)
+}
+  \item{random}{
+  logical, if \code{TRUE} (the default) starting values are randomly sampled without replacement from \code{start}, otherwise \code{start[1]} is treated as the starting values for single rules and \code{start[1:2]} for double rules. If \code{start} has length 1, the value is repeated for double rules.
+  }
+
+}
+\details{
+%%  ~~ If necessary, more details than the description above ~~
+}
+\value{
+function returns a list containing of:
+
+\item{sequenceR[[1]] }{numeric sequence as a list}
+\item{sequenceR[[2]]}{rule used to generate the sequence}
+
+}
+\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{conCheck}},
+\code{\link{check}},
+\code{\link{createSR}},
+\code{\link{createDR}}
+
+}
+\examples{
+sequenceR(rule=new("AddConstSingleRule",constantVal=1,previousRule=new("IdenSingleRule")),start=99,seqlen=6)
+
+}
+% Add one or more standard keywords, see file 'KEYWORDS' in the
+% R documentation directory.
+\keyword{ ~kwd1 }
+\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line



More information about the Ruler-commits mailing list