file.show

R Base 3.6.2

Display one or more (plain) text files, in a platform specific way, typically via a ‘pager’.

Syntax

file.show(&#8230;, header = rep("", nfiles),
          title = "R Information",
          delete.file = FALSE, pager = getOption("pager"),
          encoding = "")

Arguments

Parameter	Description
`…`	one or more character vectors containing the names of the files to be displayed. Paths with have tilde expansion.
`header`	character 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 single separate window is used for the display, title will be used as the window title. If multiple windows are used, their titles should combine the title and the file-specific header.
`delete.file`	should the files be deleted after display? Used for temporary files.
`pager`	the pager to be used: not used on all platforms
`encoding`	character string giving the encoding to be assumed for the file(s).

Details

This function provides the core of the R help system, but it can be used for other purposes as well, such as page. How the pager is implemented is highly system-dependent. The basic Unix version concatenates the files (using the headers) to a temporary file, and displays it in the pager selected by the pager argument, which is a character vector specifying a system command (a full path or a command found on the PATH) to run on the set of files. The ‘factory-fresh’ default is to use R_HOME/bin/pager, which is a shell script running the command-line specified by the environment variable PAGER whose default is set at configuration, usually to less. On a Unix-alike more is used if pager is empty. Most GUI systems will use a separate pager window for each file, and let the user leave it up whil

Examples

Example

# NOT RUN {
file.show(file.path(R.home("doc"), "COPYRIGHTS"))
# }

file.show

Syntax

Arguments

Details

Examples

See Also