Skip to content

Easier ways to create .Rd files?

6 messages · Jonathan Greenberg, Kevin Wright, Philippe GROSJEAN +2 more

Original
Jonathan Greenberg
# 
R-helpers:

Are there any ways to auto-generate R-friendly (e.g. will pass a
compilation check) .Rd files given a set of .R code?  How about GUIs
that help properly format the .Rd files?  Thanks!  I want a basic set
of .Rd files that I can update as I go, but as with most things my
documentation typically lags behind my coding by a few days.

--j
Philippe GROSJEAN
#
On 24/08/11 01:55, Jonathan Greenberg wrote:
See inlinedocs package on CRAN. There are several examples included.
Best,

Philippe Grosjean
Jonathan Greenberg
# 
Thanks Kevin!  Got started with roxygen tonight!  Cheers!
On Tue, Aug 23, 2011 at 6:28 PM, Kevin Wright <kw.stat at gmail.com> wrote:

  
    

      
      
    

  


  


      

    

    

      
      

        


  

        

      Yihui Xie
    

    

      
      #
    

  


  

      
To avoid a possible confusion, please note it is roxygen2 rather than
roxygen; both are packages on CRAN, but roxygen2 is an improved
version and under maintenance; I guess the development of the original
roxygen package has stopped.

Emacs+ESS helps a whole lot in writing documentation! I really love C-c C-o

Regards,
Yihui
--
Yihui Xie <xieyihui at gmail.com>
Phone: 515-294-2465 Web: http://yihui.name
Department of Statistics, Iowa State University
2215 Snedecor Hall, Ames, IA



On Wed, Aug 24, 2011 at 3:31 AM, Jonathan Greenberg

        
<greenberg at ucdavis.edu> wrote:

            

      
      
      
    

        

      
      
    

            

      
      
      
    

        

      
      
    

  
  


  


      

    

    
1 day later

    

      
      

        


  

        

      Greg Snow
    

    

      
      #
    

  


  

      
For the initial .Rd file look at the 'prompt' function, it will create a basic .Rd file based on the current function definition with all the structure in place, then you go in and edit it to have more meaningful information.