freeze                package:tframe                R Documentation

_G_e_t _f_i_x_e_d _d_a_t_a _s_n_a_p_s_h_o_t

_D_e_s_c_r_i_p_t_i_o_n:

     Generic method. See specific methods for details.

_U_s_a_g_e:

         freeze(data, ...)
         ## Default S3 method:
         freeze(data, ...)

_A_r_g_u_m_e_n_t_s:

    data: A data source description.

     ...: Additional arguments for specific methods.

_D_e_t_a_i_l_s:

     This function extracts data from  a database (for example using
     the TS PADI programs are available  at <URL:
     www.bank-banque-canada.ca/pgilbert>). This method is generic. The
     function logically belongs with the tfpadi functions in the
     dsepadi package but the generic and default are included here
     since they are required in many functions whereas the database
     interface has much more limited use. Typically the argument data
     is a tfPADIdata or TSPADIdata object identifying  the source of
     the data. See help for tfPADIdata and TSPADIdata.  The default
     method usually just returns its argument, so freeze has no effect.
     This way freeze can be used to write functions which will take a
     snapshot from the database when they execute or will work with an
     already fixed copy of data if that is what is supplied. The
     default does allow for a character argument, in which case it is
     used to construct a tfPADIdata object using server="ets", then
     freeze that object. This allows for a simple syntax to grab a
     series from the database. The server="ets" is for convenience at
     the Bank of Canada and another default server might be more
     convenient elsewhere.

_S_e_e _A_l_s_o:

     'tfPADIdata' 'tfputpadi' 'freeze.tfPADIdata' 'freeze.TSPADIdata'
     'TSPADIdata'

