posterior_linpred.mvgam {mvgam} | R Documentation |
Posterior Draws of the Linear Predictor
Description
Compute posterior draws of the linear predictor, that is draws before applying any link functions or other transformations. Can be performed for the data used to fit the model (posterior predictive checks) or for new data.
Usage
## S3 method for class 'mvgam'
posterior_linpred(
object,
transform = FALSE,
newdata,
ndraws = NULL,
data_test,
process_error = TRUE,
...
)
Arguments
object |
|
transform |
Logical; if |
newdata |
Optional |
ndraws |
Positive |
data_test |
Deprecated. Still works in place of |
process_error |
Logical. If |
... |
Ignored |
Details
Note that for all types of predictions for models that did not include
a trend_formula
, uncertainty in the dynamic trend
component can be ignored by setting process_error = FALSE
. However,
if a trend_formula
was supplied in the model, predictions for this component cannot be
ignored. If process_error = TRUE
, trend predictions will ignore autocorrelation
coefficients or GP length scale coefficients, ultimately assuming the process is stationary.
This method is similar to the types of posterior predictions returned from brms
models
when using autocorrelated error predictions for newdata.
This function is therefore more suited to posterior simulation from the GAM components
of a mvgam
model, while the forecasting functions
plot_mvgam_fc
and forecast.mvgam
are better suited to generate h-step ahead forecasts
that respect the temporal dynamics of estimated latent trends.
Value
A matrix
of dimension n_samples x new_obs
,
where n_samples
is the number of posterior samples from the fitted object
and n_obs
is the number of observations in newdata
See Also
posterior_epred.mvgam
posterior_predict.mvgam
hindcast.mvgam
posterior_epred.mvgam
posterior_predict.mvgam
Examples
# Simulate some data and fit a model
simdat <- sim_mvgam(n_series = 1, trend_model = 'AR1')
mod <- mvgam(y ~ s(season, bs = 'cc'),
trend_model = AR(),
noncentred = TRUE,
data = simdat$data_train,
chains = 2)
# Extract linear predictor values
linpreds <- posterior_linpred(mod)
str(linpreds)