MultiATSM1.5.1 package

Multicountry Term Structure of Interest Rates Models

Adjust_Const_Type

Adjust the constant label

adjust_delta

Adjust delta for numerical differentiation

AdjustOptm_BS

Gathers the estimate of the bootstrap draws

AdjustPathFEVDs

Generate paths to save IRFs/GIRFs graphs

AdjustPathIRFs

Generate paths to save IRFs/GIRFs graphs

AdjustYieldsDates

Makes sure that the time series of yields and risk factors have coinci...

autoplot.ATSMModelBoot

Autoplot method for ATSMModelBoot objects

autoplot.ATSMNumOutputs

Autoplot method for ATSMNumOutputs objects

autoplot

Autoplot generic function

Aux_BlockDiag

Transformation of the block diagonal parameters (auxiliary form)

Aux_JLLstruct

Transformation of the JLL-related parameters (auxiliary form)

Aux_jordan_OneCountry

Auxiliary function for a single-country specification

Aux_Jordan

Transformation of the Jordan-related parameters (auxiliary form)

Aux_PSD

Transformation of a PSD matrix (auxiliary form)

Bias_Correc_VAR

Estimates an unbiased VAR(1) using stochastic approximation (Bauer, Ru...

Boot_DataGraphFact_perShock

Generates the desired bootstrap graphs

Boot_DataGraphYield_perShock

Generates the desired bootstrap graphs

Boot_Fac_Graphs

Build P-dynamic graphs after the bootstrap implementation

Boot_graph_template

Builds template from bootstrap-related graphs

Boot_Yields_Graphs

Build P-dynamic graphs after the bootstrap implementation

Bootstrap

Generates the bootstrap-related outputs

BootstrapBoundsSet

Builds the confidence bounds and graphs (Bootstrap set)

BuildATSM_RiskFactors

Builds the time series of the risk factors that are used in the estima...

BuildCI_Yields

Build Confidence intervals for yield-related outputs

BuildFEVDlist

Build the list of IRF and GIRF for both factors and bond yields

BuildGVAR

Build the GVAR(1) from the country-specific VARX(1,1,1)

BuildIRFlist

Build the list of IRF and GIRF for both factors and bond yields

BuildLinkMat

Build country-specific link matrices

BuildRiskFactors_BS

Build the time-series of the risk factors in each bootstrap draw

BuildYields_BS

Build the time-series of bond yields for each bootstrap draw

BUnspannedAdapJoint

Transform B_spanned into B_unspanned for jointQ models

BUnspannedAdapSep_BS

Obtain the full form of B unspanned for "sep Q" models within the boot...

BUnspannedAdapSep

Transform B_spanned into B_unspanned for sepQ models

Check_comparison_NoBC

check how close the mean or median of the bias-corrected aproach is fr...

Check_label_consistency

Check consistency of labels (economies, domestic and global variables)

check_numeric

Check for presence of NAs and infinite in numeric variables

CheckInput_K1X

Input validation for the 'FeedMat_Q' function

CheckInputsForMLE

Check consistence of inputs

CheckInputsGVAR

Check consistency of the inputs provided in GVARinputs

CheckJLLinputs

Check consistency of the inputs provided in JLL-based models

CheckNumericalPrecision

Check Numerical Precision Issues of K1_root matrix

ChecksOOS

Preliminary checks for inputs provided for the performing out-of-sampl...

CholRestrictionsJLL

Impose the zero-restrictions on the Cholesky-factorization from JLL-ba...

clean_labels

Modify variable labels to make legends more readable

CleanOrthoJLL_Boot

Clean unnecessary outputs of JLL models in the bootstrap setup

Compute_BnX_AnX

Compute the latent loading AnX and BnX

Compute_EP

Compute the expected component for all models

ComputeBounds_FEVDandGFEVD

Compute the confidence bounds around the P-dynamics and bond yields fo...

ComputeBounds_IRFandGIRF

Compute the confidence bounds from the model's numerical outputs

ComputeFEVDs

Compute FEVDs for all models

ComputeGFEVDs

Compute GFEVDs for all models

ComputeGIRFs

Compute GIRFs for all models

ComputeIRFs

Compute IRFs of all models

DatabasePrep

Gather data of several countries in a list. Particularly useful for GV...

DataForEstimation

Retrieves data from Excel and builds the database used in the model es...

DataSet_BS

Prepare the factor set for GVAR models (Bootstrap version)

Est_K1h

Estimate K1h

Est_RestOLS

Estimate a restricted OLS model

EstimationSigma_GVARrest

Estimate numerically the variance-covariance matrix from the GVAR-base...

EstimationSigma_Ye

Estimate numerically the Cholesky-factorization from the JLL-based mod...

ExpectedComponent

Get the expected component of all models

FacQuantile_bs

Compute quantiles for model P-dynamics

FactorBounds_FEVDandGFEVD

Compute the confidence bounds for the model bond P-dynamics-related ou...

FactorBounds_IRFandGIRF

Compute the confidence bounds for the model P-dynamics

Factors_NonOrtho

Makes the pre-allocation of the factors set for JLL-based models

FeedbackMat_BS

Compute the Feedback matrix of each bootstrap draw

FeedbackMatrixRestrictionsJLL

Set the zero-restrictions on the feedback matrix of JLL's P-dynamics

FeedMat_M

Computes an average or median feedback matrix across several bootstrap...

FeedMat_Q

Get an estimate for the risk-neutral (Q) feedback matrix

FEVDandGFEVD_BS

FEVDs and GFEVDs after bootstrap for all models

FEVDandGFEVD

FEVDs and GFEVDs for all models

FEVDandGFEVDbs

Creates the confidence bounds and the graphs of FEVDs and GFEVDs after...

FEVDandGFEVDgraphs

FEVD and GFEVD graphs for all models

FEVDandGFEVDs_Graphs

Generates graphs for FEVDs and GFEVDs

Fit_Subplot

Build subplot for fitted yields

Fitgraphs

Model fit graphs for all models

FolderCreation_Boot

Creates folder to store graphs generated from the bootstrap analysis

FolderCreationBoot

Creates the folders and the path in which the graphical outputs are st...

FolderCreationPoint

Creates the folders and the path in which the graphical outputs are st...

FolderPrep_FEVDs

Create folders for storing IRFs and GIRFs

FolderPrep_IRFs

Create folders for storing IRFs and GIRFs

ForecastYields

Generates forecasts of bond yields for all model types

ForwardPremia

Compute the forward premia for all models

FunctionML_vec

Use function ML to generate the outputs from a ATSM

Gather_Forecasts

Gather several forecast dates

GaussianDensity

computes the density function of a gaussian process

Gen_art_series

Simulate N_Boot dataset from the P-dynamics

Gen_Artificial_Series

Generate artificial time-series in the bootstrap setup

Gen_Forecast_Yields

Compute the bond yield forecast for any model type

GeneralMLEInputs

Gathers the general inputs for model estimation

Get__BnXAnX

Compute the cross-section loadings of yields of a canonical A0_N model

Get_a0

Obtain the country-specific a0

Get_As

Compute the A loadings

Get_BFull

Compute the B matrix of loadings

Get_Bs

Build the B loadings

Get_FeedMat_NoBC

Estimate feedback matrix from several models (No bias-corrected versio...

Get_G0G1Sigma

Get the intercept, feedback matrix and the variance-covariance matrix ...

Get_Gy1

Compute the feedback matrix from a GVAR model with global factors

Get_llk

Compute the log-likelihood function

Get_r0

Compute long-run risk neutral mean (r0) for the various models

Get_Sigma_JLL

Compute Sigmas/Cholesky factorizations

Get_SigmaYields

Compute the variance-covariance matrix of the bond yields

Get_SSZ_BC

Compute the variance-covariance matrix after the bias correction proce...

Get_Unspanned

Collect both the domestic and global unspanned factors of all countrie...

GetAuxPara

Compute the auxiliary parameters a.

Getdt

Get delta t

GetLabels_JLL

Generate the variable labels of the JLL models

GetLabels_sepQ

Generate the factor labels for models estimated on a country-by-countr...

GetPdynPara_BC

Compute P-dynamics parameters using the bias correction method from BR...

GetPdynPara_NoBC

Compute P-dynamics parameters without using the bias correction method...

GetPdynPara

Compute the parameters used in the P-dynamics of the model

GetTruePara

Map auxiliary (unconstrained) parameters a to constrained parameters b

GetYields_AllCountries

Gather all country-specific yields in a single matrix of dimension CJ ...

GraphicalOutputs

Generate the graphical outputs for the selected models (Point estimate...

GVAR_PrepFactors

Prepare risk factors for the estimation of the GVAR model

GVAR

Estimates a GVAR(1) and VARX(1,1,1) models

Idx_UnspanFact

Obtain the indexes of both the domestic and global unspanned factors

IdxAllSpanned

Find the indexes of the spanned factors

IdxSpanned

Extract the indexes related to the spanned factors in the variance-cov...

IDXZeroRestrictionsJLLVarCovOrtho

Find the indexes of zero-restrictions from the orthogonalized variance...

ImposeStat_Aux

Impose stationary constraint under the risk-neutral measure

ImposeStat_True

Makes sure that the stationary constraint under the risk-neutral measu...

InputsForOpt

Generates inputs necessary to build the likelihood function for the AT...

InputsForOutputs

Collects the inputs that are used to construct the numerical and graph...

Intra_Yields

Fit the cross-section of yields using spline

InvMat_Robust

Robust method for matrix inversion

IRFandGIRF_BS

IRFs and GIRFs after bootstrap for all models

IRFandGIRF

IRFs and GIRFs for all models

IRFandGIRFbs

Creates the confidence bounds and the graphs of IRFs and GIRFs after b...

IRFandGIRFgraphs

IRF and GIRF graphs for all models

IRFandGIRFs_Format_Fac

Gather data for IRFs and GIRFs grahs (version "Factors")

IRFandGIRFs_Format_Yields

Gather data for IRFs and GIRFs grahs (version "Yields")

Jac_approx

Main Jacobian approximation

JLL

Estimates the P-dynamics from JLL-based models

Jordan_JLL

Check for JLL models for Jordan restrictions (auxiliary form)

JordanMat

Convert a Matrix to Jordan-Like Form for Term Structure Models

K1XQStationary

Impose stationarity under the Q-measure

LabelsSpanned

Generate the labels of the spanned factors

LabelsStar

Generate the labels of the star variables

LabFac

Generates the labels for risk factors used in the model

llk_JLL_Sigma

Build the log-likelihood function of the P-dynamics from the JLL-based...

Load_Excel_Data

Read data from Excel files and return a named list of data frames

LoadData

Loads data sets from several papers

MarginalModelPara

Estimate the marginal model for the global factors

MatAdjusted

Adjust vector of maturities

Maturities

Create a vector of numerical maturities in years

MergeFEVD_graphs

Limit the number of categories in FEVDs and GFEVDs graphs by merging s...

ML_stable

Prevents algorithm to end up in ill-defined likelihood

MLEdensity

Compute the maximum likelihood function of all models

MLFunction

Set up the vector-valued objective function (Point estimate)

MLtemporary

Mean of the llk function used in the estimation of the selected ATSM

MultiATSM_datasets

Overview of Datasets Included in the MultiATSM Package

MultiATSM

ATSM Package

NoOrthoVAR_JLL

Obtain the non-orthogonalized model parameters

NumOutputs_Bootstrap

Numerical outputs (IRFs, GIRFs, FEVD, and GFEVD) for bootstrap

NumOutputs

Constructs the model numerical outputs (model fit, IRFs, GIRFs, FEVDs,...

OOS_Forecast

Perform out-of-sample forecast of bond yields

Optimization_PE

Perform the minimization of ML function

Optimization_Time

Compute the time elapsed in the numerical optimization

Optimization

Perform the optimization of the log-likelihood function of the chosen ...

OptimizationSetup_ATSM

Optimization routine for the entire selected ATSM

OptOutputs

Prepare outputs to export after the model optimization

OrthoReg_JLL

Get coefficients from the orthogonalized regressions

OrthoVAR_JLL

VAR(1) with orthogonalized factors (JLL models)

OutputConstruction

Numerical outputs (variance explained, model fit, IRFs, GIRFs, FEVDs, ...

Outputs2exportMLE

Prepares inputs to export

ParaLabelsOpt

Create the variable labels used in the estimation

pca_weights_one_country

Computes the PCA weights for a single country

PdynResid_BS

Compute some key parameters from the P-dynamics (Bootstrap set)

plot.ATSMModelForecast

Plot method for ATSMModelForecast objects

pos_map

Exponential transformation

print.ATSMModelInputs

Print method for ATSMModelInputs objects

Reg_demean

Perform a linear regression using demeaned variables

RemoveNA

Exclude series that contain NAs

ResampleResiduals_BS

Compute the residuals from the original model

residY_original

Compute the residuals from the observational equation

rhoParas

Compute risk-neutral intercept and slope

richardson_diff

Richardson extrapolation

RiskFactorsGraphs

Spanned and unspanned factors plot

RiskFactorsPrep

Builds the complete set of time series of the risk factors (spanned an...

RMSE

Compute the root mean square error for all models

RootEigen

Compute the root of the eigenvalue of K1h

Rotate_Lat_Obs

Rotate latent states to observed ones

SA_algorithm

Stochastic approximation algorithm

safe_solve

Safe matrix inversion with conditioning check

scaling_from_jacobian

Scaling vector computation

shrink_FeedMat_BC

Shrinking the largest eigenvalue

Spanned_Factors

Computes the country-specific spanned factors

SpecificMLEInputs

Concatenate the model-specific inputs in a list

summary.ATSMModelInputs

Summary method for ATSMModelInputs objects

summary.ATSMModelOutputs

Summary method for ATSMModelOutputs objects

TermPremia

Compute the term premia

TermPremiaDecomp

Decomposition of yields into the average of expected future short-term...

TimeVarWeights_GVAR

Compute the star variables with time-varying weights

TPDecompGraph

Term Premia decomposition graphs for all models

Transition_Matrix

Computes the transition matrix required in the estimation of the GVAR ...

True_BlockDiag

Transformation of the block diagonal parameters (true form)

True_JLLstruct

Transformation of the JLL-related parameters (true form)

True_jordan_OneCountry

True function for a single-country specification

True_Jordan

Transformation of the Jordan-related parameters (True form)

True_PSD

Transformation of a PSD matrix (true form)

Update_ParaList

Update parameters in the optimization process

Update_SSZ_JLL

Update the variance-covariance matrix from the "JLL joint Sigma" model...

VAR

Estimates a standard VAR(1)

VarianceExplained

Percentage explained by the spanned factors of the variations in the s...

VARX

Estimate a VARX(1,1,1)

Wished_Graphs_FEVDandGFEVD

Extract list of desired graph features (IRFs anc GIRFs)

Wished_Graphs_IRFandGIRF

Extract list of desired graph features (IRFs anc GIRFs)

WishGraphs_FEVDandGFEVD_Boot

Extract graphs of interest (bootstrap version)

WishGraphs_IRFandGIRF_Boot

Extract graphs of interest (bootstrap version)

withDefault

Check default value

Y_Fit

Model-implied yields (cross-section)

Y_ModImp

Model-implied yields (P-dynamics)

YieldBounds_FEVDandGFEVD

Compute the confidence bounds for the model bond yield-related outputs

YieldBounds_IRFandGIRF

Compute the confidence bounds for the model bond yield-related outputs

YieldFor

Compile the bond yield forecast for any model type

YieldQuantile_bs

Compute quantiles for model bond yield-related outputs

YieldsFit

Computes two measures of model fit for bond yields (all models)

YieldsFitAll

Fit yields for all maturities of interest

Package for estimating, analyzing, and forecasting multi-country macro-finance affine term structure models (ATSMs). All setups build on the single-country unspanned macroeconomic risk framework from Joslin, Priebsch, and Singleton (2014, JF) <doi:10.1111/jofi.12131>. Multicountry extensions by Jotikasthira, Le, and Lundblad (2015, JFE) <doi:10.1016/j.jfineco.2014.09.004>, Candelon and Moura (2023, EM) <doi:10.1016/j.econmod.2023.106453>, and Candelon and Moura (2024, JFEC) <doi:10.1093/jjfinec/nbae008> are also available. The package also provides tools for bias correction as in Bauer Rudebusch and Wu (2012, JBES) <doi:10.1080/07350015.2012.693855>, bootstrap analysis, and several graphical/numerical outputs.

  • Maintainer: Rubens Moura
  • License: GPL-2 | GPL-3
  • Last published: 2025-11-05