svMisc (version 0.9-70)

isHelp: Is there a help file and example to run associated with an object?

Description

Determine if 'topic' has a help file and example to run.

Usage

isHelp(topic, package = NULL, lib.loc = NULL)

Arguments

topic

name or literal character string: the online help topic to look for.

package

a character vector giving the package names to look into for help or example code, or NULL. By default, all packages in the search path are used.

lib.loc

a character vector of directory names of R libraries, or NULL. The default value of NULL corresponds to all libraries currently known. If the default is used, the loaded packages are searched before the libraries.

Value

A logical vector with two elements. The first one indicating if there is a help file, and the second one indicating if there are examples associated with this help file.

Examples

isHelp("help")		# Help and example
isHelp("Rtangle")	# Help but no example
isHelp("notopic")	# No help or example