R/dyadMLM-package.R

In dyadMLM: Tools for Dyadic Multilevel Models

# Package-level documentation. The title, authors, and links are taken from
# DESCRIPTION through roxygen2's "_PACKAGE" sentinel.

#' @description
#' `dyadMLM` validates and prepares cross-sectional and intensive longitudinal
#' dyadic data for multilevel modeling. It creates model-ready variables for
#' APIMs, DIMs, and DSMs and provides supporting post-estimation tools.
#'
#' @section Main functions:
#' - [prepare_dyad_data()] validates long-format dyadic data and creates
#'   model-ready variables.
#' - [compare_nested_models()] compares compatible nested `glmmTMB`
#'   models fitted to equivalent data.
#' - [recover_exchangeable_covariance()] back-transforms exchangeable
#'   shared/difference random-effect covariance structures into member-level
#'   quantities.
#' - [simulate_dyad_responses()] and [check_partner_dependence()] provide
#'   experimental predictive comparisons of response variances and partner
#'   correlations.
#' - [check_dyad_residuals()] and [check_dyad_outcomes()] compare residual and outcome
#'   distributions using the same simulations.
#'
#' @section Example data:
#' See [dyads_cross] and [dyads_ild] for Gaussian examples, and
#' [dyads_nbinom_cross] and [dyads_nbinom_ild] for negative-binomial examples.
#'
#' @section Getting started:
#' See `vignette("getting-started", package = "dyadMLM")` for an overview.
#' The APIM, DIM, and DSM vignettes provide model-specific examples.
#'
#' @keywords internal
"_PACKAGE"