Man pages for MultiATSM
Multicountry Term Structure of Interest Rates Models

A0N__BnAnCompute the cross-section loadings of yields of a canonical...
Adjust_Const_TypeAdjust the constant label
adjust_deltaAdjust delta for numerical differentiation
AdjustOptm_BSGathers the estimate of the bootstrap draws
AdjustPathFEVDsGenerate paths to save IRFs/GIRFs graphs
AdjustPathIRFsGenerate paths to save IRFs/GIRFs graphs
AdjustYieldsDatesMakes sure that the time series of yields and risk factors...
Aux_BlockDiagTransformation of the block diagonal parameters (auxiliary...
Aux_BoundDiagTransformation of the bounded parameters (auxiliary form)
Aux_JLLstructTransformation of the JLL-related parameters (auxiliary form)
Aux_JordanTransformation of the Jordan-related parameters (auxiliary...
Aux_PSDTransformation of a PSD matrix (auxiliary form)
Bias_Correc_VAREstimates an unbiased VAR(1) using stochastic approximation...
Boot_DataGraphFact_perShockGenerates the desired bootstrap graphs
Boot_DataGraphYield_perShockGenerates the desired bootstrap graphs
Boot_Fac_GraphsBuild P-dynamic graphs after the bootstrap implementation
Boot_graph_templateBuilds template from bootstrap-related graphs
BootstrapGenerates the bootstrap-related outputs
BootstrapBoundsSetBuilds the confidence bounds and graphs (Bootstrap set)
Boot_Yields_GraphsBuild P-dynamic graphs after the bootstrap implementation
bound2xTransform a number bounded between a lower bound and upper...
BR_jps_outReplications of the JPS (2014) outputs by Bauer and Rudebusch...
BuildATSM_RiskFactorsBuilds the time series of the risk factors that are used in...
BuildCI_YieldsBuild Confidence intervals for yield-related outputs
BuildFEVDlistBuild the list of IRF and GIRF for both factors and bond...
BuildGVARBuild the GVAR(1) from the country-specific VARX(1,1,1)
BuildIRFlistBuild the list of IRF and GIRF for both factors and bond...
BuildLinkMatBuild country-specific link matrices
BuildRiskFactors_BSBuild the time-series of the risk factors in each bootstrap...
Build_xvecObtain the auxiliary values corresponding to each parameter,...
BuildYields_BSBuild the time-series of bond yields for each bootstrap draw
BUnspannedAdapJointTransform B_spanned into B_unspanned for jointQ models
BUnspannedAdapSepTransform B_spanned into B_unspanned for sepQ models
BUnspannedAdapSep_BSObtain the full form of B unspanned for "sep Q" models within...
Check_comparison__OLScheck whether mean/median of OLS is close to actual OLS...
CheckInputsForMLECheck consistence of inputs
CheckInputsGVARCheck consistency of the inputs provided in GVARinputs
CheckJLLinputsCheck consistency of the inputs provided in JLL-based models
Check_label_consistencyCheck consistency of labels (economies, domestic and global...
ChecksOOSPreliminary checks for inputs provided for the performing...
CholRestrictionsJLLImpose the zero-restrictions on the Cholesky-factorization...
CleanOrthoJLL_BootClean unnecessary outputs of JLL models in the bootstrap...
Compute_BnX_AnXCompute the latent loading AnX and BnX
ComputeBounds_FEVDandGFEVDCompute the confidence bounds around the P-dynamics and bond...
ComputeBounds_IRFandGIRFCompute the confidence bounds from the model's numerical...
Compute_EPCompute the expected component for all models
ComputeFEVDsCompute FEVDs for all models
ComputeGFEVDsCompute GFEVDs for all models
ComputeGIRFsCompute GIRFs for all models
ComputeIRFsCompute IRFs of all models
Convert2JordanFormConvert a generic matrix to its Jordan form
DatabasePrepGather data of several countries in a list. Particularly...
DataForEstimationRetrieves data from Excel and build the database used in the...
DataSet_BSPrepare the factor set for GVAR models (Bootstrap version)
df__dxComputes numerical first order derivative of f(x)
DomesticMacroVarData: Risk Factors - Candelon and Moura (2024, JFEC)
DomMacroData: Risk Factors for the GVAR - Candelon and Moura (2023)
EstimationSigma_GVARrestEstimate numerically the variance-covariance matrix from the...
EstimationSigma_YeEstimate numerically the Cholesky-factorization from the...
estVARbrwEstimate a VAR(1) - suited to Bauer, Rudebusch and Wu (2012)...
ExpectedComponentGet the expected component of all models
FacQuantile_bsCompute quantiles for model P-dynamics
FactorBounds_FEVDandGFEVDCompute the confidence bounds for the model bond...
FactorBounds_IRFandGIRFCompute the confidence bounds for the model P-dynamics
FactorsGVARData: Risk Factors for the GVAR - Candelon and Moura (2024,...
Factors_NonOrthoMakes the pre-allocation of the factors set for JLL-based...
FeedbackMat_BSCompute the Feedback matrix of each bootstrap draw
FeedbackMatrixRestrictionsJLLSet the zero-restrictions on the feedback matrix of JLL's...
FEVDandGFEVDFEVDs and GFEVDs for all models
FEVDandGFEVDbsCreates the confidence bounds and the graphs of FEVDs and...
FEVDandGFEVD_BSFEVDs and GFEVDs after bootstrap for all models
FEVDandGFEVDgraphsFEVD and GFEVD graphs for all models
FEVDandGFEVDs_GraphsGenerates graphs for FEVDs and GFEVDs
FFmean of the llk function used in the estimation of the...
FFtemporaryMean of the llk function used in the estimation of the...
FitgraphsModel fit graphs for all models
Fit_SubplotBuild subplot for fitted yields
FMN__RotatePerforms state rotations
FolderCreationBootCreates the folders and the path in which the graphical...
FolderCreation_BootCreates folder to store graphs generated from the bootstrap...
FolderCreationPointCreates the folders and the path in which the graphical...
FolderPrep_FEVDsCreate folders for storing IRFs and GIRFs
FolderPrep_IRFsCreate folders for storing IRFs and GIRFs
ForecastYieldsGenerates forecasts of bond yields for all model types
ForwardPremiaCompute the forward premia for all models
FunctionfSet up the vector-valued objective function (Point estimate)
Functionf_vectorizedUse function f to generate the outputs from a ATSM
Gather_ForecastsGather several forecast dates
GaussianDensitycomputes the density function of a gaussian process
Gen_Artificial_SeriesGenerate artificial time-series in the bootstrap setup
GeneralMLEInputsGathers the general inputs for model estimation
Gen_Forecast_YieldsCompute the bond yield forecast for any model type
genVARbrwGenerate M data sets from VAR(1) model
Get_a0Obtain the country-specific a0
Get_AsCompute the A loadings
GetAuxParaMap constrained parameters b to unconstrained auxiliary...
Get_BFullCompute the B matrix of loadings
Get_BsBuild the B loadings
GetdtGet delta t
Get_G0G1SigmaGet the intercept, feedback matrix and the...
Get_Gy1Compute the feedback matrix from a GVAR model with global...
GetLabels_JLLGenerate the variable labels of the JLL models
GetLabels_sepQGenerate the factor labels for models estimated on a...
Get_llkCompute the log-likelihood function
GetPdynParaCompute the parameters used in the P-dynamics of the model
GetPdynPara_BCCompute P-dynamics parameters using the bias correction...
GetPdynPara_NoBCCompute P-dynamics parameters without using the bias...
Get_r0Compute r0 for the various models
Get_Sigma_JLLCompute Sigmas/Cholesky factorizations
Get_SigmaYieldsCompute the variance-covariance matrix of the bond yields
GetTrueParaMap auxiliary (unconstrained) parameters a to constrained...
Get_UnspannedCollect both the domestic and global unspanned factors of all...
Get_V_tilde_BCCompute the variance-covariance matrix after the bias...
GetYields_AllCountriesGather all country-specific yields in a single matrix of...
GlobalMacroData: Risk Factors - Candelon and Moura (2023)
GlobalMacroVarData: Risk Factors - Candelon and Moura (2024, JFEC)
GraphicalOutputsGenerate the graphical outputs for the selected models (Point...
GVAREstimates a GVAR(1) and a VARX(1,1,1) models
GVAR_PrepFactorsPrepare risk factors for the estimation of the GVAR model
IdxAllSpannedFind the indexes of the spanned factors
IdxSpannedExtract the indexes related to the spanned factors in the...
Idx_UnspanFactObtain the indexes of both the domestic and global unspanned...
IDXZeroRestrictionsJLLVarCovOrthoFind the indexes of zero-restrictions from the orthogonalized...
ImposeStat_AuxImpose stationary constraint under the risk-neutral measure
ImposeStat_TrueMakes sure that the stationary constraint under the...
InputsForOptGenerates inputs necessary to build the likelihood function...
InputsForOutputsCollects the inputs that are used to construct the numerical...
IRFandGIRFIRFs and GIRFs for all models
IRFandGIRFbsCreates the confidence bounds and the graphs of IRFs and...
IRFandGIRF_BSIRFs and GIRFs after bootstrap for all models
IRFandGIRFgraphsIRF and GIRF graphs for all models
IRFandGIRFs_Format_FacGather data for IRFs and GIRFs grahs (version "Factors")
IRFandGIRFs_Format_YieldsGather data for IRFs and GIRFs grahs (version "Yields")
JLLEstimates the P-dynamics from JLL-based models
Jordan_JLLCheck for JLL models for Jordan restrictions (auxiliary form)
K1XQStationaryImpose stationarity under the Q-measure
LabelsSpannedGenerate the labels of the spanned factors
LabelsStarGenerate the labels of the star variables
LabFacGenerates the labels factors
llk_JLL_SigmaBuild the log-likelihood function of the P-dynamics from the...
LoadDataLoads data sets from several papers
MarginalModelParaEstimate the marginal model for the global factors
MatAdjustedAdjust vector of maturities
MaturitiesCreate a vector of numerical maturities in years
MLEdensityCompute the maximum likelihood function of all models
ModelParaReplications of the JPS (2014) outputs by the MultiATSM...
MultiATSMATSM Package
mult__prodEfficient computation of matrix product for arrays
m_varFind mean or median of OLS when DGP is VAR(1)
NoOrthoVAR_JLLObtain the non-orthogonalized model parameters
NumOutputsConstructs the model numerical outputs (model fit, IRFs,...
NumOutputs_BootstrapNumerical outputs (IRFs, GIRFs, FEVD, and GFEVD) for...
OOS_ForecastPerform out-of-sample forecast of bond yields
OptimizationPerform the optimization of the log-likelihood function of...
Optimization_PEPeform the minimization of mean(f)
OptimizationSetup_ATSMOptimization routine for the entire selected ATSM
Optimization_TimeCompute the time elapsed in the numerical optimization
OptOutputsPrepare outputs to export after the model optimization
OrthoReg_JLLGet coefficients from the orthogonalized regressions
OrthoVAR_JLLVAR(1) with orthogonalized factors (JLL models)
OutComplete list of several outputs from an ATSM
OutputConstructionNumerical outputs (variance explained, model fit, IRFs,...
Outputs2exportMLEPrepares inputs to export
ParaATSM_opt_ALLUpdate the list of parameters
ParaLabelsOptCreate the variable labels used in the estimation
pca_weights_one_countryComputes the PCA weights for a single country
PdynResid_BSCompute some key parameters from the P-dynamics (Bootstrap...
plot.ATSMModelForecastPlot method for ATSMModelForecast objects
pos2xTransform a positive number y to back to x by:
print.ATSMModelInputsPrint method for ATSMModelInputs objects
Reg_K1QEstimate the risk-neutral feedbak matrix K1Q using linear...
Reg__OLSconstrainedRestricted OLS regression
RemoveNAExclude series that contain NAs
ResampleResiduals_BSCompute the residuals from the original model
residY_originalCompute the residuals from the observational equation
rhoParasCompute risk-neutral intercept and slope
RiskFactorsData: Risk Factors - Candelon and Moura (2024, JFEC)
RiskFactorsGraphsSpanned and unspanned factors plot
RiskFactorsPrepBuilds the complete set of time series of the risk factors...
RMSECompute the root mean square error for all models
shrink_PhiKillan's VAR stationarity adjustment
Spanned_FactorsComputes the country-specific spanned factors
SpecificMLEInputsConcatenate the model-specific inputs in a list
sqrtm_robustCompute the square root of a matrix
StarFactorsGenerates the star variables necessary for the GVAR...
summary.ATSMModelInputsSummary method for ATSMModelInputs objects
summary.ATSMModelOutputsSummary method for ATSMModelOutputs objects
TermPremiaCompute the term premia
TermPremiaDecompDecomposition of yields into the average of expected future...
TimeVarWeights_GVARCompute the star variables with time-varying weights
TPDecompGraphTerm Premia decomposition graphs for all models
TradeFlowsData: Trade Flows - Candelon and Moura (2024, JFEC)
Trade_FlowsData: Trade Flows - Candelon and Moura (2023)
Transition_MatrixComputes the transition matrix required in the estimation of...
True_BlockDiagTransformation of the block diagonal parameters (true form)
True_BoundDiagTransformation of the bounded parameters (True form)
True_JLLstructTransformation of the JLL-related parameters (true form)
True_JordanTransformation of the Jordan-related parameters (True form)
True_PSDTransformation of a PSD matrix (true form)
Update_ParaListconverts the vectorized auxiliary parameter vector x to the...
Update_SSZ_JLLUpdate the variance-covariance matrix from the "JLL joint...
VAREstimates a standard VAR(1)
VarianceExplainedPercentage explained by the spanned factors of the variations...
VARXEstimate a VARX(1,1,1)
Wished_Graphs_FEVDandGFEVDExtract list of desired graph features (IRFs anc GIRFs)
Wished_Graphs_IRFandGIRFExtract list of desired graph features (IRFs anc GIRFs)
WishGraphs_FEVDandGFEVD_BootExtract graphs of interest (bootstrap version)
WishGraphs_IRFandGIRF_BootExtract graphs of interest (bootstrap version)
x2boundTransform x to a number bounded btw lb and ub by:
x2posTransform x to a positive number by: y = log(e^x + 1)
Y_FitModel-implied yields (cross-section)
YieldBounds_FEVDandGFEVDCompute the confidence bounds for the model bond...
YieldBounds_IRFandGIRFCompute the confidence bounds for the model bond...
YieldForCompile the bond yield forecast for any model type
YieldQuantile_bsCompute quantiles for model bond yield-related outputs
YieldsData: Yields - Candelon and Moura (2024, JFEC)
YieldsFitComputes two measures of model fit for bond yields (all...
YieldsFitAllFit yields for all maturities of interest
Y_ModImpModel-implied yields (P-dynamics)
MultiATSM documentation built on April 4, 2025, 1:40 a.m.