You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

69 lines
1.5 KiB

3 years ago
  1. \name{sum1}
  2. \alias{sum1}
  3. %- Also NEED an '\alias' for EACH other topic documented here.
  4. \title{
  5. %% ~~function to do ... ~~
  6. }
  7. \description{
  8. %% ~~ A concise (1-5 lines) description of what the function does. ~~
  9. }
  10. \usage{
  11. sum1(m)
  12. }
  13. %- maybe also 'usage' for other objects documented here.
  14. \arguments{
  15. \item{m}{
  16. %% ~~Describe \code{m} 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. %% ~Make other sections like Warning with \section{Warning }{....} ~
  39. \seealso{
  40. %% ~~objects to See Also as \code{\link{help}}, ~~~
  41. }
  42. \examples{
  43. ##---- Should be DIRECTLY executable !! ----
  44. ##-- ==> Define data, use random,
  45. ##-- or do help(data=index) for the standard data sets.
  46. ## The function is currently defined as
  47. function (m)
  48. {
  49. res = 0
  50. for (i in 1:dim(m)[1]) {
  51. for (j in 1:dim(m)[2]) {
  52. res <- res + m[i, j]
  53. }
  54. }
  55. return(res)
  56. }
  57. }
  58. % Add one or more standard keywords, see file 'KEYWORDS' in the
  59. % R documentation directory (show via RShowDoc("KEYWORDS")):
  60. % \keyword{ ~kwd1 }
  61. % \keyword{ ~kwd2 }
  62. % Use only one keyword per line.
  63. % For non-standard keywords, use \concept instead of \keyword:
  64. % \concept{ ~cpt1 }
  65. % \concept{ ~cpt2 }
  66. % Use only one concept per line.