R/sae4health-package.R

In sae4health: Small Area Estimation for Key Health and Demographic Indicators from Household Surveys

#' R Shiny App for Small Area Estimation of Health and Demographic Indicators
#'
#' The \strong{sae4health} package powers an \strong{R Shiny app} designed for small area estimation (SAE)
#' of health and demographic indicators in low- and middle-income countries (LMICs). It enables
#' subnational estimation and prevalence mapping for more than 150 binary indicators derived from
#' Demographic and Health Surveys (DHS), providing an intuitive interface for public health analysts,
#' policymakers, and researchers. 
#'
#' Built on the \strong{surveyPrev} package, \strong{sae4health} ensures methodological rigor in SAE analysis.
#' It offers guided model selection, automated model fitting, and interactive visualization,
#' making advanced statistical methods accessible to non-experts. 
#'
#' @name sae4health-package
#' @aliases sae4health
#'
#' @details
#' For comprehensive documentation on the \strong{sae4health} project and \strong{web-based app access}, visit:
#' \url{https://sae4health.stat.uw.edu/}
#'
#' The latest development version of the package is maintained at:
#' \url{https://github.com/wu-thomas/sae4health}
#' 
#' Citation: Wu, Y., Dong, Q., Xu, J., Li, Z. R., & Wakefield, J. (2025). 
#' \emph{sae4health: An R Shiny Application for Small Area Estimation in Low- and Middle-Income Countries}. \doi{10.48550/arXiv.2505.01467}.
#'
#' @author
#'
#' \itemize{
#'   \item Yunhan Wu [\strong{Maintainer}] (\email{wu-thomas@outlook.com})
#'   \item Qianyu Dong (\email{qdong14@ucsc.edu})
#'   \item Zehang R Li (\email{lizehang@gmail.com})
#'   \item Jon Wakefield (\email{jonno@uw.edu})
#' }
#'
#' @seealso
#' \describe{
#'   \item{\strong{Getting Started:}}{\url{https://sae4health.stat.uw.edu/overview/project_overview/}}
#'   \item{\strong{Demo and Instruction Video:}}{\url{https://sae4health.stat.uw.edu/overview/youtube_app_demo/}}
#'   \item{\strong{Statistical Methods:}}{\url{https://sae4health.stat.uw.edu/method/approach_overview/}}
#'   \item{\strong{Visualization Gallery:}}{\url{https://sae4health.stat.uw.edu/gallery/visual_overview/}}
#'   \item{\strong{Recent Updates and News:}}{\url{https://sae4health.stat.uw.edu/blog/}}
#' }
#' 
#' @references
#' Wu, Y., Dong, Q., Xu, J., Li, Z. R., & Wakefield, J. (2025). 
#' \emph{sae4health: An R Shiny Application for Small Area Estimation in Low- and Middle-Income Countries}. 
#' arXiv preprint.\doi{10.48550/arXiv.2505.01467}
#'
#'
NULL