[R] how to build specific doc types in Windows

Prof Brian Ripley ripley at stats.ox.ac.uk
Sun May 18 13:51:58 CEST 2003

That option is passed to INSTALL, and Rcmd INSTALL has help which tells 
you.  I think you want --docs=normal.

I would have thought INSTALL was the obvious place to look (especially
form the Perl code).  I normally build binary packages via Rcmd INSTALL
--build in the source tree: this ensures that help references get resolved
correctly, which Rcmd build --binary does not.

On Sun, 18 May 2003, Gordon Smyth wrote:

> I am building R packages using R 1.7.0pat under Windows 2000 Professional. 
> All works fine except that I haven't been able to figure out how to use the 
> --docs=TYPE option. I would like to optionally turn off building chm help. 
> I have tried build commands like
> rcmd build --binary --docs=TYPE mypackagename
> In place of "TYPE" I have tried things like "html", "text", "chm", "t", 
> "h", "HTML" etc, etc, but all of these break the build entirely. What are 
> the actual options for --docs=TYPE? I have tried all the documentation 
> sources I know of, plus hacking the perl code, but can't see what the 
> options are.
> Thanks
> Gordon
> For easy reference, here is the help output from rcmd build:
> Usage: Rcmd build [options] pkgdirs
> Build R packages from package sources in the directories specified by
> pkgdirs.
> Options:
>    -h, --help            print short help message and exit
>    -v, --version         print version info and exit
>    --force               force overwriting of (index) files
>    --no-vignettes        do not rebuild package vignettes
>    --binary              build pre-compiled binary packages, with options:
>    --docs=TYPE           type(s) of documentation to build and install
>    --auto-zip            select zipping of data and help based on size
>    --use-zip-data        collect data files in zip archive
>    --use-zip-help        collect help and examples into zip archives
>    --use-zip             combine '--use-zip-data' and '--use-zip-help'
> ______________________________________________
> R-help at stat.math.ethz.ch mailing list
> https://www.stat.math.ethz.ch/mailman/listinfo/r-help

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 272866 (PA)
Oxford OX1 3TG, UK                Fax:  +44 1865 272595

More information about the R-help mailing list