[R] R help question: How can we enable useRs to contribute corrections to help files faster ?

Sharpie chuck at sharpsteen.net
Sun Feb 28 19:23:00 CET 2010



Duncan Murdoch wrote:
> 
> Yes, I agree.  In fact, I think the whole system needs to be updated.  
> Anyone like doing HTML design?
> 

If I had the time, I would raise my hand for this one-- unfortunately
school, work and other commitments leave me with a full schedule for the
foreseeable future.  Now that all R man pages are presented using a HTML
server, it would be nice to overhaul the presentation.  Perhaps something
like the output of Python's Sphinx:

  http://docs.python.org/3.1/tutorial/

The key elements I'm thinking of are:

  - A sidebar with table of contents/navigation

  - A search box


Personally, I try to put an \author{} field with an email in all of my .Rd
files-- adding this as a requirement to R CMD check could enforce this
behavior.  It could also break 99% of all the package builds on CRAN.

Another way package author/maintainer emails can be quickly obtained is
through the packageDescription() function:

  packageDescription('packageName')$Maintainer


-Charlie
-- 
View this message in context: http://n4.nabble.com/R-help-question-How-can-we-enable-useRs-to-contribute-corrections-to-help-files-faster-tp1572568p1572854.html
Sent from the R help mailing list archive at Nabble.com.



More information about the R-help mailing list