Contents.m + improved help

resources/project/Root.type.Files/tbx.type.File/bear.type.File/Contents.m.type.File.xml

@@ -0,0 +1,6 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Info>
+    <Category UUID="FileClassCategory">
+        <Label UUID="design"/>
+    </Category>
+</Info>

tbx/bear/BEARsettings.m

@@ -1,9 +1,27 @@
 function [settings] = BEARsettings(VARtype, varargin)
-%BEARSETTINGS gets the corresponding settings object based on the given
-%VARtype. The user can optionally pass a name-value property with the
-%ExcelFile. Alternatively, the xlsx file in pwd is taken. If more than one
-%xlsx file exist an error is thrown. It is also possible to pass any of the
-%VARtype properties as name-value pairs.
+% BEARSETTINGS gets the corresponding settings object based on the given
+% VARtype. 
+% opts = BEARsettings(VARtype, name = value)
+% opts = BEARsettings(VARtype, ExcelFile = 'data.xlsx', name = value)
+%
+% VARtype is the type of BEAR to be estimated, and can take the values
+% OLS, BVAR, PANEL, SV, TVP, MFVAR. 
+%
+% ExcelFile is an optional key-value pair with the location in disk of the
+% Excel file with the inputs. If not specified, BEAR will use a default
+% one. 
+%
+% It is also possible to pass any of the % VARtype properties as name-value
+% paris. These will depend on the choosen VARtype
+%
+% See also:
+% <a href="matlab:doc('bear.settings.BASEsettings')">Base settings for BEAR</a>
+% <a href="matlab:doc('bear.settings.BVARsettings')">BVAR settings</a>
+% <a href="matlab:doc('bear.settings.OLSsettings')">OLS settings</a>
+% <a href="matlab:doc('bear.settings.PANELsettings')">Panel settings</a>
+% <a href="matlab:doc('bear.settings.SVsettings')">Stocahstic Volatility</a>
+% <a href="matlab:doc('bear.settings.TVPsettings')">Time Varing panel settings</a>
+% <a href="matlab:doc('bear.settings.MFVARsettings')">Mixed Frequency</a>
 
 p = inputParser;
 p.KeepUnmatched = true;

tbx/bear/Contents.m

@@ -0,0 +1,13 @@
+% BEAR summary
+% Version 5.2.0 19-Dec-2023
+%
+% Description of first group of files
+%   BEARmain        - Estimate a Bayesian VAR model using BEAR
+%   BEARsettings    - Create a settigs object with the parameters to run BEAR
+%
+% Documentation
+%   GettingStarted  - Quick guide to get started with BEAR
+%   <a href="matlab: winopen('tbx/doc/Technical guide.pdf')>">Technical Guide</a> - PDF with all implementation details on BEAR
+% 
+% For more information, see the <a href="matlab: 
+% web('https://github.com/european-central-bank/BEAR-toolbox')">BEAR GitHub page</a>.