[R] Build R Packages (man)

[Prof Brian Ripley]

You are creating a source package. You need to install it before use.
Use R CMD INSTALL or Rcmd INSTALL (Windows).  That does the conversions
for you.

BTW, to avoid grief, don't put the sources in the library into which you
wil install.  Normally sources are under RHOME/src/library and
installation into RHOME/library, but you can put sources anywhere except
in the destination library.

On Thu, 10 Jan 2002, Ko-Kang Kevin Wang wrote:

> Hi there,
>
> I'm trying to get the manual for an R package (that I'm creating) to
> work...
>
> Firstly, I created the *.Rd files (by following the instructions in
> "Writing R Extensions" and using prompt() in R, then edit the *.Rd
> files.  I then copy them into the "pkg/man" directory as suggested by the
> manual.  However when I load the library (successfully) in R, I cannot
> find the manuals for my data sets.  For example, if I type:
>    library(myLib)
>    data(foo)
> they work fine.  And I can play with the data set foo.  However then I
> type:
>   ?foo
> it cannot find the documentation which I created and placed in the /man
> directory.
>
> Secondly, I tried to convert the Rd files into html using R CMD Rdconv,
> but I cannot quite follow the manual "R CMD Rdconv --help".  I tried:
>   R CMD Rdconv --output=html man > html
> and it returns:
>   Unknown type: options are txt, html, latex, Sd, example
> I also tried several other ways but can't seem to get R CMD Rdconv to
> work.

For each file R CMD Rdconv -t html foo.Rd > foo.html.

You don't want to use --output *and* redirect, and mand anf html are
directories, not files.

> Thanks in advance for the help ;-)
>
> Cheers,
>
> Ko-Kang Wang
>
> ------------------------------------------------------------------------------
> Ko-Kang Kevin Wang
> Statistical Analysis Division Leader
> Software Developers' Klub (SDK)
> University of Auckland
> New Zealand
>
> -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
> 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
> _._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._
>

-- 
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
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._