Return to oxm.markov.Rd CVS log

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

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

1.1     ! takayama    1: \name{oxm.markov}
        !             2: \alias{oxm.markov}
        !             3: %- Also NEED an '\alias' for EACH other topic documented here.
        !             4: \title{
        !             5:   It obtains the Markov basis for a given set of points by an OpenXM server.
        !             6: }
        !             7: \description{
        !             8: %%  ~~ A concise (1-5 lines) description of what the function does. ~~
        !             9: }
        !            10: \usage{
        !            11: oxm.markov(mat)
        !            12: }
        !            13: %- maybe also 'usage' for other objects documented here.
        !            14: \arguments{
        !            15:   \item{mat}{
        !            16: %%     ~~Describe \code{mat} here~~
        !            17: }
        !            18: }
        !            19: \details{
        !            20: %%  ~~ If necessary, more details than the description above ~~
        !            21: }
        !            22: \value{
        !            23: %%  ~Describe the value returned
        !            24: %%  If it is a LIST, use
        !            25: %%  \item{comp1 }{Description of 'comp1'}
        !            26: %%  \item{comp2 }{Description of 'comp2'}
        !            27: %% ...
        !            28: }
        !            29: \references{
        !            30: %% ~put references to the literature/web site here ~
        !            31: }
        !            32: \author{
        !            33: %%  ~~who you are~~
        !            34: }
        !            35: \note{
        !            36: %%  ~~further notes~~
        !            37: }
        !            38:
        !            39: %% ~Make other sections like Warning with \section{Warning }{....} ~
        !            40:
        !            41: \seealso{
        !            42: %% ~~objects to See Also as \code{\link{help}}, ~~~
        !            43: }
        !            44: \examples{
        !            45: ##---- Should be DIRECTLY executable !! ----
        !            46: ##-- ==>  Define data, use random,
        !            47: ##--   or do  help(data=index)  for the standard data sets.
        !            48:
        !            49: ## The function is currently defined as
        !            50: function(mat) { return(mat); }
        !            51: }
        !            52: % Add one or more standard keywords, see file 'KEYWORDS' in the
        !            53: % R documentation directory.
        !            54: \keyword{ ~kwd1 }
        !            55: \keyword{ ~kwd2 }% __ONLY ONE__ keyword per line