Man pages for MultiATSM
Multicountry Term Structure of Interest Rates Models

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...
autoplotAutoplot generic function
autoplot.ATSMModelBootAutoplot method for ATSMModelBoot objects
autoplot.ATSMNumOutputsAutoplot method for ATSMNumOutputs objects
Aux_BlockDiagTransformation of the block diagonal parameters (auxiliary...
Aux_JLLstructTransformation of the JLL-related parameters (auxiliary form)
Aux_JordanTransformation of the Jordan-related parameters (auxiliary...
Aux_jordan_OneCountryAuxiliary function for a single-country specification
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
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...
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_NoBCcheck how close the mean or median of the bias-corrected...
CheckInput_K1XInput validation for the 'FeedMat_Q' function
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...
check_numericCheck for presence of NAs and infinite in numeric variables
CheckNumericalPrecisionCheck Numerical Precision Issues of K1_root matrix
ChecksOOSPreliminary checks for inputs provided for the performing...
CholRestrictionsJLLImpose the zero-restrictions on the Cholesky-factorization...
clean_labelsModify variable labels to make legends more readable
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
DatabasePrepGather data of several countries in a list. Particularly...
DataForEstimationRetrieves data from Excel and builds the database used in the...
DataSet_BSPrepare the factor set for GVAR models (Bootstrap version)
DomMacroData: domestic risk factors - Candelon and Moura (2024, JFEC)
DomMacro_covidData: 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...
Est_K1hEstimate K1h
Est_RestOLSEstimate a restricted OLS model
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
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...
FeedMat_MComputes an average or median feedback matrix across several...
FeedMat_QGet an estimate for the risk-neutral (Q) feedback matrix
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
FitgraphsModel fit graphs for all models
Fit_SubplotBuild subplot for fitted yields
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
FunctionML_vecUse function ML 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
Gen_art_seriesSimulate N_Boot dataset from the P-dynamics
GeneralMLEInputsGathers the general inputs for model estimation
Gen_Forecast_YieldsCompute the bond yield forecast for any model type
Get_a0Obtain the country-specific a0
Get_AsCompute the A loadings
GetAuxParaCompute the auxiliary parameters a.
Get_BFullCompute the B matrix of loadings
Get__BnXAnXCompute the cross-section loadings of yields of a canonical...
Get_BsBuild the B loadings
GetdtGet delta t
Get_FeedMat_NoBCEstimate feedback matrix from several models (No...
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 long-run risk neutral mean (r0) for the various...
Get_Sigma_JLLCompute Sigmas/Cholesky factorizations
Get_SigmaYieldsCompute the variance-covariance matrix of the bond yields
Get_SSZ_BCCompute the variance-covariance matrix after the bias...
GetTrueParaMap auxiliary (unconstrained) parameters a to constrained...
Get_UnspannedCollect both the domestic and global unspanned factors of all...
GetYields_AllCountriesGather all country-specific yields in a single matrix of...
GlobalMacroData: Risk Factors - Candelon and Moura (2024, JFEC)
GlobalMacro_covidData: Risk Factors - Candelon and Moura (2023, EM)
GraphicalOutputsGenerate the graphical outputs for the selected models (Point...
GVAREstimates a GVAR(1) and VARX(1,1,1) models
GVARFactorsData: Risk Factors for the GVAR - Candelon and Moura (2024,...
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...
InpForOutExExample of list inputs used in the construction of several...
InputsForOptGenerates inputs necessary to build the likelihood function...
InputsForOutputsCollects the inputs that are used to construct the numerical...
Intra_YieldsFit the cross-section of yields using spline
InvMat_RobustRobust method for matrix inversion
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")
Jac_approxMain Jacobian approximation
JLLEstimates the P-dynamics from JLL-based models
Jordan_JLLCheck for JLL models for Jordan restrictions (auxiliary form)
JordanMatConvert a Matrix to Jordan-Like Form for Term Structure...
K1XQStationaryImpose stationarity under the Q-measure
LabelsSpannedGenerate the labels of the spanned factors
LabelsStarGenerate the labels of the star variables
LabFacGenerates the labels for risk factors used in the model
llk_JLL_SigmaBuild the log-likelihood function of the P-dynamics from the...
LoadDataLoads data sets from several papers
Load_Excel_DataRead data from Excel files and return a named list of data...
MarginalModelParaEstimate the marginal model for the global factors
MatAdjustedAdjust vector of maturities
MaturitiesCreate a vector of numerical maturities in years
MergeFEVD_graphsLimit the number of categories in FEVDs and GFEVDs graphs by...
MLEdensityCompute the maximum likelihood function of all models
MLFunctionSet up the vector-valued objective function (Point estimate)
ML_stablePrevents algorithm to end up in ill-defined likelihood
MLtemporaryMean of the llk function used in the estimation of the...
MultiATSMATSM Package
MultiATSM_datasetsOverview of Datasets Included in the MultiATSM Package
NoOrthoVAR_JLLObtain the non-orthogonalized model parameters
NumOutExExample of computed numerical outputs
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_PEPerform the minimization of ML function
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)
Out_ExampleComplete list of several outputs from an ATSM
OutputConstructionNumerical outputs (variance explained, model fit, IRFs,...
Outputs2exportMLEPrepares inputs to export
ParaLabelsOptCreate the variable labels used in the estimation
ParaSetExExample of parameter set after optimization
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
pos_mapExponential transformation
print.ATSMModelInputsPrint method for ATSMModelInputs objects
Reg_demeanPerform a linear regression using demeaned variables
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
richardson_diffRichardson extrapolation
RiskFacFullData: Full set of risk factors - Candelon and Moura (2024,...
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
RootEigenCompute the root of the eigenvalue of K1h
Rotate_Lat_ObsRotate latent states to observed ones
SA_algorithmStochastic approximation algorithm
safe_solveSafe matrix inversion with conditioning check
scaling_from_jacobianScaling vector computation
shrink_FeedMat_BCShrinking the largest eigenvalue
Spanned_FactorsComputes the country-specific spanned factors
SpecificMLEInputsConcatenate the model-specific inputs in a list
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)
TradeFlows_covidData: Trade Flows - Candelon and Moura (2023, EM)
Transition_MatrixComputes the transition matrix required in the estimation of...
True_BlockDiagTransformation of the block diagonal parameters (true form)
True_JLLstructTransformation of the JLL-related parameters (true form)
True_JordanTransformation of the Jordan-related parameters (True form)
True_jordan_OneCountryTrue function for a single-country specification
True_PSDTransformation of a PSD matrix (true form)
Update_ParaListUpdate parameters in the optimization process
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)
withDefaultCheck default value
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: bond yield data - Candelon and Moura (2024, JFEC)
Yields_covidData: Yields - Candelon and Moura (2023)
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 Nov. 5, 2025, 7:01 p.m.