Rewrote headers.
parent
97580b84bb
commit
d0220e8685
|
@ -1,36 +1,20 @@
|
||||||
function [freq,init,data,varlist,tex] = load_m_file_data(file)
|
function [freq,init,data,varlist,tex] = load_m_file_data(file)
|
||||||
|
|
||||||
%@info:
|
% Loads data in a matlab/octave script.
|
||||||
%! @deftypefn {Function File} {@var{freq}, @var{init}, @var{data}, @var{varlist} =} load_m_file_data (@var{file})
|
%
|
||||||
%! @anchor{load_m_file_data}
|
% INPUTS
|
||||||
%! @sp 1
|
% o file string, name of the matlab/octave script (with path)
|
||||||
%! Loads data in a matlab/octave m-file.
|
%
|
||||||
%! @sp 2
|
% OUTPUTS
|
||||||
%! @strong{Inputs}
|
% o freq integer scalar equal to 1, 4, 12 or 52 (for annual, quaterly, monthly or weekly frequencies).
|
||||||
%! @sp 1
|
% o init dates object, initial date in the dataset.
|
||||||
%! @table @ @var
|
% o data matrix of doubles, the data.
|
||||||
%! @item file
|
% o varlist cell of strings, names of the variables.
|
||||||
%! string, name of the m file (matlab/octave script).
|
%
|
||||||
%! @end table
|
% REMARKS
|
||||||
%! @sp 2
|
% The frequency and initial date can be specified with variables FREQ__ and INIT__ in the matlab/octave script. FREQ__ must
|
||||||
%! @strong{Outputs}
|
% be a scalar integer and INIT__ a string like '1938M11', '1945Q3', '1973W3' or '2009A'. If these variables are not specified
|
||||||
%! @sp 1
|
% default values for freq and init are 1 and dates(1,1).
|
||||||
%! @table @ @var
|
|
||||||
%! @item freq
|
|
||||||
%! Scalar integer (1, 4, 12, 52).
|
|
||||||
%! @item init
|
|
||||||
%! dynDate object, initial date.
|
|
||||||
%! @item data
|
|
||||||
%! Matrix of doubles, data.
|
|
||||||
%! @item varlist
|
|
||||||
%! Cell of strings (names of the variables in the database).
|
|
||||||
%! @end table
|
|
||||||
%! @sp 2
|
|
||||||
%! @strong{Remarks}
|
|
||||||
%! @sp 1
|
|
||||||
%! The frequency and initial date can be specified with variables FREQ__ and INIT__ in the matlab/octave script. FREQ__ must be a scalar integer and INIT__ a string like '1938M11', '1945Q3', '1973W3' or '2009'. If these variables are not specified default values for freq and init are 1 and dynDate(1).
|
|
||||||
%! @end deftypefn
|
|
||||||
%@eod:
|
|
||||||
|
|
||||||
% Copyright (C) 2012-2013 Dynare Team
|
% Copyright (C) 2012-2013 Dynare Team
|
||||||
%
|
%
|
||||||
|
|
|
@ -1,36 +1,20 @@
|
||||||
function [freq,init,data,varlist,tex] = load_mat_file_data(file)
|
function [freq,init,data,varlist,tex] = load_mat_file_data(file)
|
||||||
|
|
||||||
%@info:
|
% Loads data in a matlab/octave mat-file.
|
||||||
%! @deftypefn {Function File} {@var{freq}, @var{init}, @var{data}, @var{varlist} =} load_m_file_data (@var{file})
|
%
|
||||||
%! @anchor{load_m_file_data}
|
% INPUTS
|
||||||
%! @sp 1
|
% o file string, name of the matlab/octave mat file (with path)
|
||||||
%! Loads data in a matlab/octave mat-file.
|
%
|
||||||
%! @sp 2
|
% OUTPUTS
|
||||||
%! @strong{Inputs}
|
% o freq integer scalar equal to 1, 4, 12 or 52 (for annual, quaterly, monthly or weekly frequencies).
|
||||||
%! @sp 1
|
% o init dates object, initial date in the dataset.
|
||||||
%! @table @ @var
|
% o data matrix of doubles, the data.
|
||||||
%! @item file
|
% o varlist cell of strings, names of the variables.
|
||||||
%! string, name of the mat file.
|
%
|
||||||
%! @end table
|
% REMARKS
|
||||||
%! @sp 2
|
% The frequency and initial date can be specified with variables FREQ__ and INIT__ in the matlab/octave binary file. FREQ__ must
|
||||||
%! @strong{Outputs}
|
% be a scalar integer and INIT__ a string like '1938M11', '1945Q3', '1973W3' or '2009A'. If these variables are not specified
|
||||||
%! @sp 1
|
% default values for freq and init are 1 and dates(1,1).
|
||||||
%! @table @ @var
|
|
||||||
%! @item freq
|
|
||||||
%! Scalar integer (1, 4, 12, 52).
|
|
||||||
%! @item init
|
|
||||||
%! dynDate object, initial date.
|
|
||||||
%! @item data
|
|
||||||
%! Matrix of doubles, data.
|
|
||||||
%! @item varlist
|
|
||||||
%! Cell of strings (names of the variables in the database).
|
|
||||||
%! @end table
|
|
||||||
%! @sp 2
|
|
||||||
%! @strong{Remarks}
|
|
||||||
%! @sp 1
|
|
||||||
%! The frequency and initial date can be specified with variables FREQ__ and INIT__ in the matlab/octave mat file. FREQ__ must be a scalar integer and INIT__ a string like '1938M11', '1945Q3', '1973W3' or '2009'. If these variables are not specified, default values for freq and init are 1 and dynDate(1).
|
|
||||||
%! @end deftypefn
|
|
||||||
%@eod:
|
|
||||||
|
|
||||||
% Copyright (C) 2012-2013 Dynare Team
|
% Copyright (C) 2012-2013 Dynare Team
|
||||||
%
|
%
|
||||||
|
|
Loading…
Reference in New Issue