File: Plugins.Rd

package info (click to toggle)
rcmdr 2.9-5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 14,788 kB
  • sloc: makefile: 2
file content (40 lines) | stat: -rw-r--r-- 1,659 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
\name{Plugins}
\alias{Plugins}

\title{R Commander Plug-in Packages}
\description{
  Plug-ins are R packages that extend the R Command interface.
}


\details{
An R Commander plug-in is an ordinary R package that (1) provides extensions to
the R Commander menus is a file named \code{menus.txt} located in the package's
\code{etc} directory; (2) provides call-back functions required by these menus;
and (3) in an \code{RcmdrModels:} field in the
package's \code{DESCRIPTION} file, augments the list of model objects
recognized by the R Commander. The menus provided by a plug-in package are
merged with the standard Commander menus. It is also possible to remove menus
and menu items from the standard Commander menu file or from the files of
plug-ins installed before the current one.

Plug-in packages given in the R Commander \code{plugins} option
(see \code{\link{Commander}}) are automatically loaded when the Commander
starts up. Plug-in packages may also be loaded via the Commander
\emph{Tools -> Load Rcmdr plug-in(s)} menu; a restart of the Commander is
required to install the new menus. Finally, loading a plug-in package when
the \pkg{Rcmdr} is not loaded will load the \pkg{Rcmdr} and activate the
plug-in.

An illustrative R Commander plug-in package, \pkg{RcmdrPlugin.TeachingDemos}, is
available on CRAN.

A variety of utility functions is available to support R Commander plug-in packages;
see \code{\link{Rcmdr.Utilities}}.

For more details, see Fox, \emph{Writing R Commander Plug-in Packages} at \url{https://www.john-fox.ca/RCommander/plug-ins.html}.
}

\seealso{\code{\link{Commander}}, \code{\link{Rcmdr.Utilities}}}

\keyword{misc}