Return to oxm.matrix_r2tfb.Rd CVS log

Up to [local] / OpenXM / src / R / r-client / Ropenxm / man

Annotation of OpenXM/src/R/r-client/Ropenxm/man/oxm.matrix_r2tfb.Rd, Revision 1.1

1.1     ! takayama    1: % $OpenXM$
        !             2: \name{oxm.matrix_r2tfb}
        !             3: \alias{oxm.matrix_r2tfb}
        !             4: %- Also NEED an '\alias' for EACH other topic documented here.
        !             5: \title{
        !             6:   The function oxm.matrix_r2tfb translates a matrix in R into the tfb format.
        !             7: }
        !             8: \description{
        !             9:   The matrix in R is translated into a string
        !            10:   in the tfb (tiny formula book) format.
        !            11: }
        !            12: \usage{
        !            13: oxm.matrix_r2tfb(mat,s="[",s.end="]")
        !            14: }
        !            15: %- maybe also 'usage' for other objects documented here.
        !            16: \arguments{
        !            17:   \item{mat}{
        !            18:      A matrix
        !            19:   }
        !            20:   \item{s}{
        !            21:      A string before the body.
        !            22:   }
        !            23:   \item{s.end}{
        !            24:      A string after the body.
        !            25:   }
        !            26: }
        !            27: \details{
        !            28:   The matrix in R is translated into a string
        !            29:   in the tfb (tiny formula book) format.
        !            30:   The tfb format is used in OpenXM to exchange data in a string.
        !            31: }
        !            32: \value{
        !            33: A string in the tfb format.
        !            34: }
        !            35: \references{
        !            36:  \url{http://www.openxm.org}
        !            37: }
        !            38: \author{
        !            39: %%  ~~who you are~~
        !            40: }
        !            41: \note{
        !            42: %%  ~~further notes~~
        !            43: }
        !            44:
        !            45: %% ~Make other sections like Warning with \section{Warning }{....} ~
        !            46:
        !            47: \seealso{
        !            48: \code{\link{oxm.markov}}
        !            49: }
        !            50: \examples{
        !            51: mat<-matrix(c(1,0,0,0, 1,0,1,0, 1,0,0,1,
        !            52:               1,1,0,0, 1,1,1,0, 1,1,0,1),nrow=4,ncol=6)
        !            53: oxm.matrix_r2tfb(mat)
        !            54: }
        !            55: % Add one or more standard keywords, see file 'KEYWORDS' in the
        !            56: % R documentation directory.
        !            57: \keyword{ tfb }
        !            58: \keyword{ OpenXM }