[ESS] adding new .Rd files on the fly

Vitalie Spinu spinuvit at gmail.com
Mon Sep 17 21:05:16 CEST 2012


  >> Joe Corneli <holtzermann17 at gmail.com>
  >> on Sun, 16 Sep 2012 19:51:35 +0100 wrote:

  > The question is, if I create a new .Rd file, how can I get it
  > recognized by Emacs?   It seems that if I want to document a function
  > like

  >  run.simulation

  > I should just be able to create an .Rd file called run.simulation.Rd
  > in the working directory, and have the contents show up when I press
  > C-c C-v (`ess-display-help-on-object').

C-c C-v displays help for objects already present in R; that is the help
pages packaged and loaded into running R session.

  > But that doesn't work.  Do I need to put the file in some special
  > place?  Restart R?  Or can I define some variable that will get
  > `ess-display-help-on-object' (or, I guess,
  > `inferior-ess-help-command') to always look my current working
  > directory for new .Rd files?

This is not possible. It potentially can be done, but given a very
limited use, I doubt it's worth it. The closest you can get is to open
the Rd file and press C-c C-p to preview it in help buffer. With
ido-mode on, it should have the same look and feel as
ess-display-help-on-object, because IDO caches previously visited
directories.

    Vitalie



More information about the ESS-help mailing list