make_model_object {disaggregation}R Documentation

Create the TMB model object for the disaggregation model


make_model_object function takes a disag_data object created by prepare_data and creates a TMB model object to be used in fitting.


  priors = NULL,
  family = "gaussian",
  link = "identity",
  field = TRUE,
  iid = TRUE,
  silent = TRUE



disag_data object returned by prepare_data function that contains all the necessary objects for the model fitting


list of prior values


likelihood function: gaussian, binomial or poisson


link function: logit, log or identity


logical. Flag the spatial field on or off


logical. Flag the iid effect on or off


logical. Suppress verbose output.


The model definition

The disaggregation model make predictions at the pixel level:

link(pred_i) = \beta_0 + \beta X + GP(s_i) + u_i

And then aggregates these predictions to the polygon level using the weighted sum (via the aggregation raster, agg_i):

cases_j = \sum_{i \epsilon j} pred_i \times agg_i

rate_j = \frac{\sum_{i \epsilon j} pred_i \times agg_i}{\sum_{i \epsilon j} agg_i}

The different likelihood correspond to slightly different models (y_j is the response count data):

Specify priors for the regression parameters, field and iid effect as a single named list. Hyperpriors for the field are given as penalised complexity priors you specify \rho_{min} and \rho_{prob} for the range of the field where P(\rho < \rho_{min}) = \rho_{prob}, and \sigma_{min} and \sigma_{prob} for the variation of the field where P(\sigma > \sigma_{min}) = \sigma_{prob}. Also, specify pc priors for the iid effect.

The precise names and default values for these priors are:

The family and link arguments are used to specify the likelihood and link function respectively. The likelihood function can be one of gaussian, poisson or binomial. The link function can be one of logit, log or identity. These are specified as strings.

The field and iid effect can be turned on or off via the field and iid logical flags. Both are default TRUE.

The iterations argument specifies the maximum number of iterations the model can run for to find an optimal point.

The silent argument can be used to publish/supress verbose output. Default TRUE.


The TMB model object returned by MakeADFun.


## Not run: 
 polygons <- list()
 for(i in 1:100) {
  row <- ceiling(i/10)
  col <- ifelse(i %% 10 != 0, i %% 10, 10)
  xmin = 2*(col - 1); xmax = 2*col; ymin = 2*(row - 1); ymax = 2*row
  polygons[[i]] <- rbind(c(xmin, ymax), c(xmax,ymax), c(xmax, ymin), c(xmin,ymin))

 polys <-, polygons)
 response_df <- data.frame(area_id = 1:100, response = runif(100, min = 0, max = 10))
 spdf <- sp::SpatialPolygonsDataFrame(polys, response_df)

 r <- raster::raster(ncol=20, nrow=20)
 r <- raster::setExtent(r, raster::extent(spdf))
 r[] <- sapply(1:raster::ncell(r), function(x) rnorm(1, ifelse(x %% 20 != 0, x %% 20, 20), 3))
 r2 <- raster::raster(ncol=20, nrow=20)
 r2 <- raster::setExtent(r2, raster::extent(spdf))
 r2[] <- sapply(1:raster::ncell(r), function(x) rnorm(1, ceiling(x/10), 3))
 cov_rasters <- raster::stack(r, r2)

 cl <- parallel::makeCluster(2)
 test_data <- prepare_data(polygon_shapefile = spdf, 
                           covariate_rasters = cov_rasters)
 result <- make_model_object(test_data)
## End(Not run)

[Package disaggregation version 0.1.4 Index]