viewerDataText          package:rdataviewer          R Documentation

_P_r_e_p_a_r_e _a _t_e_x_t _f_i_l_e _f_o_r _v_i_e_w_i_n_g.

_D_e_s_c_r_i_p_t_i_o_n:

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

_U_s_a_g_e:

     viewerDataText(filename, width = NULL, estimate = NULL, index = FALSE, ...)

_A_r_g_u_m_e_n_t_s:

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). 

_D_e_t_a_i_l_s:

     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.

_V_a_l_u_e:

     An object of class '"ViewerDataText"'.

_A_u_t_h_o_r(_s):

     Paul Murrell

_S_e_e _A_l_s_o:

     'ViewerDataText' and 'viewerData'

