{"name":"RShowDoc","title":"Show R Manuals and Other Documentation","pagetitle":"Show R Manuals and Other Documentation — RShowDoc","aliases":"RShowDoc","author":[],"keywords":"documentation","description":"

Utility function to find and display R documentation.

","usage":"RShowDoc(what, type = c(\"pdf\", \"html\", \"txt\"), package)","arguments":[{"name":"what","description":"

a character string: see ‘Details’.

"},{"name":"type","description":"

an optional character string giving the preferred format.\n Can be abbreviated.

"},{"name":"package","description":"

an optional character string specifying the name of a\n package within which to look for documentation.

"}],"has_args":true,"examples":"","sections":[],"details":"

what can specify one of several different sources of documentation,\n including the R manuals (R-admin, R-data, R-exts,\n R-intro, R-ints, R-lang), NEWS,\n COPYING (the GPL licence), any of the licenses in\n share/licenses, FAQ (also available as\n R-FAQ), and the files in R_HOME/doc.

Only on Windows, the R for Windows FAQ is specified by rw-FAQ.

If package is supplied, documentation is looked for in the\n doc and top-level directories of an installed package of that name.

If what is missing a brief usage message is printed.

The documentation types are tried in turn starting with the first\n specified in type (or \"pdf\" if none is specified).

","seealso":"

For displaying regular help files, help (or\n ?) and help.start.

For type = \"txt\", file.show is used.\n vignettes are nicely viewed via RShowDoc(*, package= . ).

","value":"

A invisible character string given the path to the file found.

","package":{"package":"utils","version":"3.4.1"}}

Description

Usage

Arguments

Value

Details

See Also