1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
|
\name{dummyfun}
\alias{a1}
\alias{a2}
\alias{a3}
#ifdef windows
\alias{onlywin}
#endif
#ifdef unix
\alias{onlyunix}
#endif
\title{Example in Rdpack}
\description{Dummy description.
Second sentence.
}
\usage{dummyfun(x, y, type, flag = FALSE)}
\arguments{
\item{x}{Description of \code{x}}
\item{y}{Description of \code{y}}
\item{type}{Description of \code{type}}
\item{flag}{Description of \code{flag}}
}
\details{Dummy details.
More dummy details.
#ifdef unix
These are on unix.
#endif
#ifdef windows
These are on windows.
#endif
}
\value{A list with the following components:
\item{res}{result, a number}
\item{convergence}{numeric code indicating convergence.}
}
\section{Further information}{
This is a user defined section.
}
\examples{
dummyfun(1)
#ifdef windows
## example on Windows
#endif
#ifdef unix
\dontrun{
## need to supply a suitable file path (if any) for your system
## example on unix
}
#endif
}
\keyword{kw1}
\keyword{kw2}
|