FileProgressBar           package:R.utils           R Documentation

_A _p_r_o_g_r_e_s_s _b_a_r _t_h_a_t _s_e_t_s _t_h_e _s_i_z_e _o_f _a _f_i_l_e _a_c_c_o_r_d_i_n_g_l_y

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

     Package:  R.utils 
      *Class FileProgressBar*

     'Object'
      '~~|'
      '~~+--''ProgressBar'
      '~~~~~~~|'
      '~~~~~~~+--''FileProgressBar'

     *Directly known subclasses:*


     public static class *FileProgressBar*
      extends ProgressBar

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

     FileProgressBar(pathname=NULL, ...)

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

pathname: The pathname of the output file.

     ...: Other arguments accepted by the 'ProgressBar' constructor.

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

     A progress bar that sets the size of a file accordingly. This
     class useful to check the progress of a batch job by just querying
     the size of a file, for instance, via ftp.

_F_i_e_l_d_s _a_n_d _M_e_t_h_o_d_s:

     *Methods:*

         'remove'  Removes the progress file for a file progress bar.
         'update'  Updates file progress bar.

     *Methods inherited from ProgressBar*:
      as.character, getBarString, increase, isDone, reset, setMaxValue,
     setProgress, setStepLength, setTicks, setValue, update

     *Methods inherited from Object*:
      $, $<-, [[, [[<-, as.character, attach, attachLocally,
     clearCache, clone, detach, equals, extend, finalize, gc,
     getEnvironment, getFields, getInstanciationTime,
     getStaticInstance, hasField, hashCode, ll, load, objectSize,
     print, save

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

     Henrik Bengtsson (<URL: http://www.braju.com/R/>)

_E_x_a_m_p_l_e_s:

       ## Not run: 
       
     # Creates a progress bar (of length 100) that displays it self as a file.
     pb <- FileProgressBar("~/progress.simulation")
     reset(pb)
     while (!isDone(pb)) {
       x <- rnorm(3e4)
       increase(pb)
       Sys.sleep(0.01)
     }

       ## End(Not run)
      

