[Uhcluster-members] r4 - pkg/man

[noreply at r-forge.r-project.org]

Author: danlin
Date: 2009-03-05 20:04:35 +0100 (Thu, 05 Mar 2009)
New Revision: 4

Added:
   pkg/man/testfun.Rd
Log:


Added: pkg/man/testfun.Rd
===================================================================
--- pkg/man/testfun.Rd	                        (rev 0)
+++ pkg/man/testfun.Rd	2009-03-05 19:04:35 UTC (rev 4)
@@ -0,0 +1,46 @@
+\name{testfun}
+\alias{testfun}
+%- Also NEED an '\alias' for EACH other topic documented here.
+\title{ ~~function to do ... ~~ }
+\description{
+  ~~ A concise (1-5 lines) description of what the function does. ~~
+}
+\usage{
+testfun(x)
+}
+%- maybe also 'usage' for other objects documented here.
+\arguments{
+  \item{x}{ ~~Describe \code{x} here~~ }
+}
+\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{ ~~objects to See Also as \code{\link{help}}, ~~~ }
+\examples{
+##---- Should be DIRECTLY executable !! ----
+##-- ==>  Define data, use random,
+##--	or do  help(data=index)  for the standard data sets.
+
+## The function is currently defined as
+function(x){
+ y=x+1
+ return(y)
+  }
+}
+% Add one or more standard keywords, see file 'KEYWORDS' in the
+% R documentation directory.
+\keyword{ ~kwd1 }
+\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line