COMMENT(The basic layout of a raw documentation file is as follows.) COMMENT(-----------------------------------------------------------) TITLE(~~name~~ @@ ~~~short description~~~) USAGE( One or more lines showing the synopsis of the function. These are set verbatim in typewriter font. ) ALIAS(other R function with same help page) ALIAS(alias-2) ARGUMENTS( ARG(arg1 @@ Description of arg1.) ARG(arg2 @@ Description of arg2.) ) DESCRIPTION( A precise description of what the function does. ) VALUE( A description of the value returned. For multiple values as list, use 'VALUES' (below) INSTEAD... ) VALUES( A description of the LIST of values returned. Use ARG(comp1 @@ Description of `comp1') ARG(comp2 @@ Description of `comp2') ... ) REFERENCES( Optional references section. ) SEEALSO( LANG(LINK(other help)), .... ) COMMENT(------- Examples: TAKE time to do this well !!! ------------ ------- ======== They should be executable ``immediately'' by cut & paste; i.e, you must construct data, use standard data sets, or random numbers. EXAMPLES( x <- 1:100 foo.bar(x) ) COMMENT(-------------------------- just a short reminder ------------ BOLD bold font ITALIC italic font LANG typewriter font for language fragments ==================== PARA -- New paragraph BLANK -- leave a blank line in an example DOTS -- the dots in function argument list LDOTS -- for ellipsis dots MATH: --> See ``ABOUT'' )