viewerDataText: Prepare a text file for viewing.

Description Usage Arguments Details Value Author(s) See Also

View source: R/data-text.R

Description

This function derives various important attributes of a text file and stores them so that viewing the file can occur efficiently.

Usage

1
viewerDataText(filename, width = NULL, estimate = NULL, index = TRUE, ...)

Arguments

filename

Name of the file.

width

The number of characters on each line to view.

estimate

A number of lines of the file to be read to estimate the maximum line length.

index

A logical value indicating whether to generate a byte index to the start of each line in the file.

...

Arguments passed to the function(s) used to read the file (not currently used).

Details

If both width and estimate are NULL then the maximum line width is determined by reading the entire file.

For large files, setting index=TRUE will vastly speed up the initialisation and viewing of the file.

Value

An object of class "ViewerDataText".

Author(s)

Paul Murrell

See Also

ViewerDataText and viewerData


pmur002/rdataviewer documentation built on May 25, 2019, 10:21 a.m.