\Header{freeze}{Get fixed data snapshot}
\methalias{freeze.default}{freeze}
\keyword{programming}{freeze}
\keyword{ts}{freeze}
\keyword{data}{freeze}
\begin{Description}\relax
Generic method. See specific methods for details.
\end{Description}
\begin{Usage}
\begin{verbatim}
    freeze(data, ...)
    ## Default S3 method:
    freeze(data, ...)
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{data}] A data source description.
\item[\code{...}] Additional arguments for specific methods.
\end{ldescription}
\end{Arguments}
\begin{Details}\relax
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.
\end{Details}
\begin{SeeAlso}\relax
\code{\Link{tfPADIdata}}
\code{\Link{tfputpadi}}
\code{\Link{freeze.tfPADIdata}}
\code{\Link{freeze.TSPADIdata}}
\code{\Link{TSPADIdata}}
\end{SeeAlso}

