[R] bringing up R documentation for my functions

S.McClatchie s.mcclatchie at niwa.cri.nz
Fri Mar 9 04:55:38 CET 2001


Colleagues

----------------------------------
System info:
R version rw1022 on NT
ESS v. 5.1.18 using emacs ver. 20.4

----------------------------------
I want to documnet a function I've written. I used 
prompt(function.name)
to create an ascii R documentation file. I moved the .Rd file into a 
subdirectory called 
rw1022/library/my.functions/man

Now I want to load the help using 
?function.name
but I know there's a step necessary to go from the ascii file to the proper 
format.

I see from the R-exts.pdf that "R objects are documented in files written in 
“R documentation” (Rd) format, a simple markup language closely 
resembling (La)T E X, which can be processed into a variety of formats, 
including LaT E X, html and plain text. The translation is carried out by 
the Perl script Rdconv in ‘$R_HOME/bin’ and by the installation scripts 
for packages."

I don't have Rdconv in the /rw1022/bin. Can you give me some advice on 
where to go from here?

Thanks, your help will be appreciated.

Sam

Sam McClatchie, Research scientist (fisheries acoustics))))))))))
NIWA (National Institute of Water & Atmospheric Research Ltd)
PO Box 14 901, Kilbirnie, Wellington, New Zealand
s.mcclatchie at niwa.cri.nz 

                    /\
...>><xX(°> // \\
                 /// \\\   
                //// \\\\
               ///  <°)Xx><<
              /////  \\\\\\
        ><(((°>   
  >><(((°>   ...>><xX(°>O<°)Xx><<

-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
r-help mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To: r-help-request at stat.math.ethz.ch
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._



More information about the R-help mailing list