Skip to contents

Package

drmTMB-package
drmTMB: Distributional Regression Models Using TMB

Model specification

Formula constructors, family objects, and status-marked model syntax.

drm_formula() bf()
Build a drmTMB formula object
meta_V() meta_known_V()
Known sampling covariance terms
meta_vcov_bivariate()
Build paired bivariate sampling covariance
beta()
Beta response family
beta_binomial()
Beta-binomial response family
cumulative_logit()
Cumulative logit ordinal response family
student()
Student-t response family
lognormal()
Lognormal response family
nbinom2()
Negative binomial 2 response family
truncated_nbinom2()
Zero-truncated negative binomial 2 response family
biv_gaussian()
Bivariate Gaussian response family

Structured-effect markers

Fitted and planned random-effect scale, structured covariance, and latent-correlation formula syntax. Each topic names its current status.

random_effect_scale_formulas sd sd1 sd2 sd_phylo sd_phylo1 sd_phylo2
Random-effect scale formula syntax
animal()
Animal-model structured-effect marker
phylo()
Phylogenetic structured-effect marker
spatial()
Spatial structured-effect marker
relmat()
User-supplied relatedness structured-effect marker
corpair()
Latent random-effect correlation formula marker

Reserved marker internals

Older reserved formula markers kept out of the main reader path.

gr()
Legacy reserved known-covariance group effect marker

Family internals

Family constructor helpers.

Model fitting and post-fit tools

Fit, diagnose, summarize, predict, and simulate distributional models.

drmTMB()
Fit a distributional regression model with TMB
drm_control()
Control fitting and fitted-object storage
check_drm()
Check convergence and diagnostic flags for a drmTMB fit
confint(<drmTMB>)
Confidence intervals for fitted model parameters
profile_targets()
List confidence-interval targets for a fitted model
corpairs()
Extract fitted correlation pairs
fitted(<drmTMB>)
Extract fitted response values
fixef()
Extract fixed-effect coefficients
nobs(<drmTMB>) df.residual(<drmTMB>) deviance(<drmTMB>)
Extract standard model-fit quantities
marginal_parameters()
Marginal summaries of predicted distributional parameters
prediction_grid()
Build prediction grids for distributional-parameter summaries
predict_parameters()
Predict distributional parameters in long format
predict(<drmTMB>)
Predict distributional parameters
ranef()
Extract conditional random-effect estimates
residuals(<drmTMB>)
Extract model residuals
rho12()
Extract residual correlation rho12
sigma(<drmTMB>)
Extract fitted scale or dispersion
simulate(<drmTMB>)
Simulate from a fitted model
summary(<drmTMB>)
Summarize a fitted model
weights(<drmTMB>)
Extract likelihood weights

Visualization

Optional plotting helpers for post-fit tables. Exported plotting functions appear here.

plot_corpairs()
Plot fitted correlation-pair summaries
plot_parameter_surface()
Plot predicted distributional-parameter surfaces