From francoisromain at free.fr  Tue Jan 24 11:33:24 2006
From: francoisromain at free.fr (Romain Francois)
Date: Tue, 24 Jan 2006 11:33:24 +0100
Subject: [Rd] generate Rd file from R file
Message-ID: <43D60274.5000808@free.fr>

Hi,

Is there something similar to javadoc or doxygen for R, ie ability to 
create a first draft of an Rd file reading the comments that are in a 
script file?

For example, for the weighted.mean function in base, one could write the 
source as :

weighted.mean <- function(
x,             #@ a numeric vector containing the values whose mean is to be computed. 
w,             #@ a vector of weights the same length as |x| giving the weights to use for each element of |x|.
na.rm = FALSE  #@ a logical value indicating whether |NA |values in |x| should be stripped before the computation proceeds.
)
#e wt <- c(5,  5,  4,  1)/15
#e x <- c(3.7,3.3,3.5,2.8)
#e xm <- weighted.mean(x,wt)


and get a draft file more full than what may be created with prompt.
Of course, I do not ask for a way to not write all the information in 
one file ... but some can be shared between R and Rd

Romain



-- 
visit the R Graph Gallery : http://addictedtor.free.fr/graphiques
mixmod 1.7 is released : http://www-math.univ-fcomte.fr/mixmod/index.php
+---------------------------------------------------------------+
| Romain FRANCOIS - http://francoisromain.free.fr               |
| Doctorant INRIA Futurs / EDF                                  |
+---------------------------------------------------------------+



[Rd] generate Rd file from R file
Romain Francois