displayCode: Displays the contents of a text file with line numbers and...

In R.utils: Various Programming Utilities

Displays the contents of a text file with line numbers and more

Description

Displays the contents of a text file with line numbers and more.

Usage

## Default S3 method:
displayCode(con=NULL, code=NULL, numerate=TRUE, lines=-1, wrap=79, highlight=NULL,
  pager=getOption("pager"), ...)

Arguments

con	A connection or a character string filename. If code is specified, this argument is ignored.
code	A character vector of code lines to be displayed.
numerate	If TRUE, line are numbers, otherwise not.
lines	If a single numeric, the maximum number of lines to show. If -1, all lines are shown. If a vector of numeric, the lines numbers to display.
wrap	The (output) column numeric where to wrap lines.
highlight	A vector of line number to be highlighted.
pager	If "none", code is not displayed in a pager, but only returned. For other options, see file.show().
...	Additional arguments passed to file.show(), which is used to display the formatted code.

Value

Returns (invisibly) the formatted code as a character string.

Author(s)

Henrik Bengtsson

See Also

file.show().

Examples

file <- system.file("DESCRIPTION", package="R.utils")
cat("Displaying: ", file, ":\n", sep="")
displayCode(file)

file <- system.file("NEWS.md", package="R.utils")
cat("Displaying: ", file, ":\n", sep="")
displayCode(file, numerate=FALSE, lines=100:110, wrap=65)

file <- system.file("NEWS.md", package="R.utils")
cat("Displaying: ", file, ":\n", sep="")
displayCode(file, lines=100:110, wrap=65, highlight=c(101,104:108))

R.utils documentation built on Nov. 18, 2023, 1:09 a.m.