Package: disaggregation 0.4.0

disaggregation: Disaggregation Modelling

Fits disaggregation regression models using 'TMB' ('Template Model Builder'). When the response data are aggregated to polygon level but the predictor variables are at a higher resolution, these models can be useful. Regression models with spatial random fields. The package is described in detail in Nandi et al. (2023) <doi:10.18637/jss.v106.i11>.

Authors:Anita Nandi [aut], Tim Lucas [aut, cre], Rohan Arambepola [aut], Andre Python [aut], Simon Smart [ctb]

# Install 'disaggregation' in R:

install.packages('disaggregation', repos = c('https://timcdlucas.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/timcdlucas/disaggregation/issues

Uses libs:

c++– GNU Standard C++ Library v3

On CRAN:

cpp

4.34 score 2 stars 11 scripts 594 downloads 11 exports 56 dependencies

Last updated from:51660f4533. Checks:13 OK. Indexed: yes.

Target	Result	Time
linux-devel-arm64	OK	242
linux-devel-x86_64	OK	236
source / vignettes	OK	328
linux-release-arm64	OK	238
linux-release-x86_64	OK	493
macos-release-arm64	OK	328
macos-release-x86_64	OK	512
macos-oldrel-arm64	OK	404
macos-oldrel-x86_64	OK	527
windows-devel	OK	325
windows-release	OK	223
windows-oldrel	OK	207
wasm-release	OK	148

Exports:as.disag_data build_mesh disag_model getCovariateRasters getPolygonData getStartendindex make_model_object plot_disag_model_data predict_model predict_uncertainty prepare_data

Dependencies:backports broom class classInt cli cowplot cpp11 data.table DBI dplyr e1071 farver fmesher generics ggplot2 glue gtable isoband KernSmooth labeling lattice lifecycle magrittr MASS Matrix pillar pkgconfig proxy purrr R6 RColorBrewer Rcpp RcppEigen rlang rSPDE s2 S7 scales sf sp sparseMVN splancs stringi stringr terra tibble tidyr tidyselect tidyterra TMB units utf8 vctrs viridisLite withr wk

A short introduction to the disaggregation package

Example

Rendered fromdisaggregation.Rmdusingknitr::rmarkdown

Last update: 2024-11-13
Started: 2019-10-15

Citation

Development and contributors

Readme and manuals

Help Manual

Help page	Topics
Function to fit the disaggregation model	as.disag_data
Build mesh for disaggregaton model	build_mesh
Fit the disaggregation model	disag_model
Roxygen commands	dummy
Get a SpatRaster of covariates from a folder containing .tif files	getCovariateRasters
Extract polygon id and response data into a data.frame from a sf object	getPolygonData
Function to match pixels to their corresponding polygon	getStartendindex
Create the TMB model object for the disaggregation model	make_model_object
Convert results of the model ready for plotting	plot_disag_model_data
Plot input data for disaggregation	plot.disag_data
Plot results of fitted model	plot.disag_model
Plot mean and uncertainty predictions from the disaggregation model results	plot.disag_prediction
Function to predict mean from the model result	predict_model
Function to predict uncertainty from the model result	predict_uncertainty
Predict mean and uncertainty from the disaggregation model result	predict.disag_model
Prepare data for disaggregation modelling	prepare_data
Print function for disaggregation input data	print.disag_data
Print function for disaggregation fit result.	print.disag_model
Print function for disaggregation prediction	print.disag_prediction
Summary function for disaggregation input data	summary.disag_data
Summary function for disaggregation fit result	summary.disag_model
Summary function for disaggregation prediction	summary.disag_prediction