Dear all,
I am writing my small working library. I have done most of the work and it
seems working well in R. The library name appears in the package list when
I type help.start().
Now my problem is about the help files. I have done help file in Rd format
and translated it to HTML format (I have a subdirectory (named html) with
html file in it and a subdirectory (named help) with .Rd files in it) .
What I want are:
1. I can use those help files when i open the help windows with help.start
();;
2. When I type help(function name) in R command window, the help file will
jump out on the screen.
I think there must be some introduction somewhere. I couldn't find it in
'Writing R Extension'. Could anybody point out somewhere or some wayI
can
implement the above two things?
Thanks a lot!
Huan
This message and any attachments (the "message") is
intended solely for the addressees and is confidential.
If you receive this message in error, please delete it and
immediately notify the sender. Any use not in accord with
its purpose, any dissemination or disclosure, either whole
or partial, is prohibited except formal approval. The internet
can not guarantee the integrity of this message.
BNP PARIBAS (and its subsidiaries) shall (will) not
therefore be liable for the message if modified.
---------------------------------------------
Ce message et toutes les pieces jointes (ci-apres le
"message") sont etablis a l'intention exclusive de ses
destinataires et sont confidentiels. Si vous recevez ce
message par erreur, merci de le detruire et d'en avertir
immediatement l'expediteur. Toute utilisation de ce
message non conforme a sa destination, toute diffusion
ou toute publication, totale ou partielle, est interdite, sauf
autorisation expresse. L'internet ne permettant pas
d'assurer l'integrite de ce message, BNP PARIBAS (et ses
filiales) decline(nt) toute responsabilite au titre de ce
message, dans l'hypothese ou il aurait ete modifie.
-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
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
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._
You need to INSTALL your package (as `libraries' are really called in R). That will automatically set up all the documentation files you need. The help directory does not contain .Rd files: it contains text files translated by Rdconv. On Mon, 25 Nov 2002 huan.huang at bnpparibas.com wrote:> > Dear all, > > I am writing my small working library. I have done most of the work and it > seems working well in R. The library name appears in the package list when > I type help.start(). > > Now my problem is about the help files. I have done help file in Rd format > and translated it to HTML format (I have a subdirectory (named html) with > html file in it and a subdirectory (named help) with .Rd files in it) . > What I want are: > > 1. I can use those help files when i open the help windows with help.start > ();; > 2. When I type help(function name) in R command window, the help file will > jump out on the screen. > > I think there must be some introduction somewhere. I couldn't find it in > 'Writing R Extension'. Could anybody point out somewhere or some wayI can > implement the above two things?Writing R Extensions starts Creating R packages Packages provide a mechanism for loading optional code and attached documentation as needed. The R distribution provides several packages, such as eda, mva, and stepfun. In the following, we assume that you know the library() command, including its lib.loc argument, and we also assume basic knowledge of R CMD INSTALL. Otherwise, please look at R's help pages ?library ?INSTALL before reading on. -- Brian D. Ripley, ripley at stats.ox.ac.uk Professor of Applied Statistics, http://www.stats.ox.ac.uk/~ripley/ University of Oxford, Tel: +44 1865 272861 (self) 1 South Parks Road, +44 1865 272860 (secr) Oxford OX1 3TG, UK Fax: +44 1865 272595 -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.- 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 _._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._