Access Add-On Module

DESCRIPTION:

An add-on module is sold separately from S-PLUS and is accessed by means of this function. It can be composed of additional S-PLUS functions and object code.

USAGE:

module(section=NULL, first=T, help=NULL, unload=F)

OPTIONAL ARGUMENTS:

section
character string or name giving the name of the module to attach or detach.
first
if TRUE, module attaches the data directory for the module section requested before the system functions and data, in position 2 of the search list; otherwise, it attaches the section at the end of the search list.
help
character string or name of a module on which help is desired. Help for a section gives (at least) a list of objects in the section with brief descriptions. Once you attach a section, you can use the help function to get documentation on particular objects in the section.
unload
if TRUE, the module named by the section argument is unloaded. This operation ends up performing the equivalent of detach to remove the module's data directory from the search list. This should be used instead of using detach directly, as their behaviors may be slightly different.
mod.loc
this argument is used for internal testing, users should never have to set this value.

VALUE:

module returns (invisibly) the position in the search list at which it attached the data directory for the requested module. If you called module to get help on a module, module returns NULL. module will not attach the same module twice; if the section is already attached it will return the position at which it is attached.

SIDE EFFECTS:

module prints documentation and attaches or detaches a data directory. If you give the help argument, then module prints information on the contents of the section specified by help. Otherwise, module attaches or detaches the data directory for the specified module.

DETAILS:

If module is called with no arguments, it prints short descriptions for all of the installed add-on modules.

SEE ALSO:

, , .

EXAMPLES:

module(help="spatial")    # documentation on spatial module
module(spatial)           # load spatial module
module(spatial, unload=T) # unload spatial module