hints: List functions that act on an object

In leeper/hints: Provide hints on what to do next

Description

Once you create an object of a particular type, remembering the functions that exist to act on that object can be difficult. This function provides a simple list of these functions.

Usage

hints(x, class = base::class(x), all.packages=FALSE)

Arguments

x	Any R object. Either x or class must be supplied.
class	A class of objects; the default is the class of x.
all.packages	If TRUE, look in all available packages for functions to list; if FALSE (the default), use only packages that have already been loaded.

Value

This function returns an object with S3 class c("hints") giving a list of functions that accept objects of the specified class, the package that includes the function, and a short description of what that function does. The descriptions are taken from the title entry of the documentation for the function. The print method will put the results in a separate window.

The object is compatible with the xtable package to get LaTeX output, and all the arguments to xtable can be used.

Author(s)

This function was written by Hadley Wickham, [e-mail], based on a suggestion by Sanford Weisberg at the useR! 2006 conference in Vienna. Minor changes were made by Sanford Weisberg, [e-mail]

See Also

print.hints

Examples

## Not run: 
m <- lm(BOD)
hints(m)
library(xtable)
xtable(hints(m))

## End(Not run)

leeper/hints documentation built on May 21, 2019, 12:37 a.m.