predict.disag_model: Predict mean and uncertainty from the disaggregation model...

In aknandi/disaggregation: Disaggregation Modelling

Predict mean and uncertainty from the disaggregation model result

Description

predict.disag_model function takes a disag_model object created by disaggregation::disag_model and predicts mean and uncertainty maps.

Usage

## S3 method for class 'disag_model'
predict(
  object,
  new_data = NULL,
  predict_iid = FALSE,
  N = 100,
  CI = 0.95,
  newdata = NULL,
  ...
)

Arguments

object	disag_model object returned by disag_model function.
new_data	If NULL, predictions are made using the data in model_output. If this is a raster stack or brick, predictions will be made over this data.
predict_iid	logical. If TRUE, any polygon iid effect from the model will be used in the prediction. Default FALSE.
N	Number of realisations. Default: 100.
CI	Credible interval to be calculated from the realisations. Default: 0.95.
newdata	Deprecated.
...	Further arguments passed to or from other methods.

Details

To predict over a different spatial extent to that used in the model, a SpatRaster covering the region to make predictions over is passed to the argument new_data. If this is not given predictions are made over the data used in the fit.

The predict_iid logical flag should be set to TRUE if the results of the iid effect from the model are to be used in the prediction.

For the uncertainty calculations, the number of the realisations and the size of the credible interval to be calculated are given by the arguments N and CI respectively.

Value

An object of class disag_prediction which consists of a list of two objects:

mean_prediction	List of: prediction Raster of mean predictions based. field Raster of the field component of the linear predictor. iid Raster of the iid component of the linear predictor. covariates Raster of the covariate component of the linear predictor.
uncertainty_prediction:	List of: realisations SpatRaster of realisations of predictions. Number of realisations defined by argument N. predictions_ci SpatRaster of the upper and lower credible intervals. Defined by argument CI.

Examples

## Not run: 
predict(fit_result)

## End(Not run)

aknandi/disaggregation documentation built on Nov. 17, 2024, 12:57 p.m.