file.show {base}R Documentation

Display One or More Files

Description

This function provides the core of the R help system, but it can be used for other purposes as well.

Usage

file.show(..., header, title="R Information",
          delete.file=FALSE, pager=getOption("pager"))

Arguments

... one or more character vectors containing the names of the files to be displayed.
header vector (of the same length as the number of files specified in ...) giving a header for each file being displayed. Defaults to empty strings.
title an overall title for the display. If a separate window is used for the display, title will be used as the window title.
delete.file should the files be deleted after display? Used for temporary files.
pager the pager to be used.

Note

How the pager is implemented is system dependent. The basic Unix version concatentates files and displays them in the pager selected by the pager argument, which is a character vector specifying a system command to run on the set of files. GUI models will allow special pagers which for instance could put up a file in a separate window and let the user leave it up while R continues running. The selection of such pagers could either be done using ``magic'' pager names being intercepted by lower-level code, or by letting pager be an R function which will be called with the same arguments as file.show and take care of interfacing to the GUI.

Author(s)

Ross Ihaka, Brian Ripley.

See Also

files, list.files, help.

Examples

file.show(paste(R.home(),
    "COPYRIGHTS", sep=.Platform$file.sep))