## ----setup, include = FALSE---------------------------------------------------
knitr::opts_chunk$set(collapse = TRUE, comment = "#>")

## ----diagram, echo = FALSE, out.width = "100%", fig.alt = "Call graph of the Stem package, organized in four layers: data and model object, estimation engine, simulation and prediction, spatially-clustered STEM"----
knitr::include_graphics("function-map.svg")

## ----file, eval = FALSE-------------------------------------------------------
# system.file("extdata", "STEM_function_map.svg", package = "Stem")

## ----session, eval = FALSE----------------------------------------------------
# library(Stem)
# data(povalley)
# 
# # 1. build the model object
# mod <- STEM_Model(z = ..., covariates = ..., coordinates = ...,
#                   phi = ..., A = ...)
# 
# # 2. the pooled benchmark
# pooled <- STEM_Estimation(mod, distance = "geo")
# 
# # 3. explore the (K, phi) grid and select
# ic  <- SCSTEM_Infocrit(mod, K_grid = 1:4, distance = "geo")
# sel <- SCSTEM_Select(ic)
# 
# # 4. quantify the uncertainty, partition included
# boot <- SCSTEM_Bootstrap(sel$fit, B = 200, seed = 1)
# inf  <- SCSTEM_BootInference(boot)

## ----edges, eval = FALSE------------------------------------------------------
# system.file("extdata", "STEM_function_map.md", package = "Stem")

## ----verification, eval = FALSE-----------------------------------------------
# browseURL(system.file("extdata", "STEM_model_verification.html", package = "Stem"))

