| link.html.help {base} | R Documentation |
Update HTML documentation files
Description
Functions to re-create the HTML documentation files to reflect all
installed packages. make.packages.html creates
the list of packages and make.search.html creates the
database used by the Java search engine. link.html.help runs
both
Usage
link.html.help(verbose=FALSE, lib.loc=.Library)
make.packages.html(lib.loc=.libPaths())
make.search.html(lib.loc=.Library)
Arguments
verbose |
logical. If true, print out a message. For use to explain a delay when called from other functions. |
lib.loc |
character vector. List of libraries to be included. |
Details
Only packages in the system library .Library are included
in the search database by default, as cross-library links do not work
on this platform.
This will give a warning if the files are not writeable.
Value
No value is returned. The file(s) ‘R\_HOME\doc\html\packages.html’ and/or ‘R\_HOME\doc\html\search\index.txt’ are (re-)created.
Note
You will need write permission in the ‘R\_HOME\doc\html’ directory.
Author(s)
Guido Masarotto and Brian Ripley