Dump Objects in Specified Chapter

DESCRIPTION:

Dumps all S-PLUS objects from any or all databases associated with the specified chapter.

USAGE:

dumpChapter(chapter=1, meta=T, silent=F, prefix="", useMethods=F)

OPTIONAL ARGUMENTS:

chapter
integer representing the chapter's position in the search path, or character string giving the name or full path of the chapter.
meta
if supplied, restricts the dumped files to the corresponding metadata. For example, meta="regular" dumps the files all.Sdata and all.S, while meta="methods" dumps meta.Sdata.
If meta is missing, an additional file, DUMP_FILES, is written, containing the names of all files needed to move the chapter, submit it to version control programs, etc.
silent
logical flag. If TRUE, the messages generated by dumpChapter about files being written are suppressed.
prefix
character string specifying a subdirectory of the chapter directory where you want the files to be written. This subdirectory must exist before calling dumpChapter.
useMethods
logical flag. If TRUE, use any existing methods for the function dput in dumping functions and language objects. Unless you have special methods of your own for such objects, there is no need to use such methods. (See dump.)

VALUE:

the chapter argument is returned invisibly.

SIDE EFFECTS:

Files containing S-PLUS objects are created.

DETAILS:

If chapter is a directory, the files are dumped there. Otherwise, a subdirectory of the working chapter (the chapter in position 1 of the search list) is created (a message is printed telling you the name of the directory) and files are written there. One consequence of this is that the system databases, which are normally installed read-only, cannot be dumped via dumpChapter .

SEE ALSO:

.

EXAMPLES:

# dump the class and methods metadata from 
# the working directory
dumpChapter(1, meta="methods")