init
This commit is contained in:
65
ue01/twosums/man/sum2.Rd
Normal file
65
ue01/twosums/man/sum2.Rd
Normal file
@@ -0,0 +1,65 @@
|
||||
\name{sum2}
|
||||
\alias{sum2}
|
||||
%- 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{
|
||||
sum2(m)
|
||||
}
|
||||
%- maybe also 'usage' for other objects documented here.
|
||||
\arguments{
|
||||
\item{m}{
|
||||
%% ~~Describe \code{m} 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 (m)
|
||||
{
|
||||
res = .C("sum2", mtrx = as.double(m), m = as.integer(dim(m)[1]),
|
||||
n = as.integer(dim(m)[2]), res = as.double(0))
|
||||
return(res$res)
|
||||
}
|
||||
}
|
||||
% Add one or more standard keywords, see file 'KEYWORDS' in the
|
||||
% R documentation directory (show via RShowDoc("KEYWORDS")):
|
||||
% \keyword{ ~kwd1 }
|
||||
% \keyword{ ~kwd2 }
|
||||
% Use only one keyword per line.
|
||||
% For non-standard keywords, use \concept instead of \keyword:
|
||||
% \concept{ ~cpt1 }
|
||||
% \concept{ ~cpt2 }
|
||||
% Use only one concept per line.
|
Reference in New Issue
Block a user