[R] Documenting a function: How to get the comments in a function similar to args()

A.Ajakh aajakh at stonebrook.ws
Fri Aug 15 01:15:40 CEST 2008


Hi All,

Imagine that we have a function defined as follows:
foo <- 
# comments line 1
# comments line 2
# etc..
function(x){
x <- 2
}
I can use args(foo) to get the arguments for foo. Is there any function to
get 
the comment lines at the beginning of the function?
>From what I understand the prompt() function allows one to create a .Rd file
which
can be compiled but I am not there yet. 
On page 31 of "Programming with Data" (J. Chambers) one can read that the
help ? function does what I want but It does not work the same way in R I
guess.
I use R version 2.7.0 on Win XP.
Thank you for your time.
AA.



More information about the R-help mailing list