Extract residual correlation rho12

rho12() returns the residual response-response correlation from a bivariate Gaussian drmTMB fit. By default it returns the response-scale correlation. Use type = "link" for the Fisher-z-like linear predictor whose response transform is 0.99999999 * tanh(eta).

Usage

rho12(object, ...)

# S3 method for class 'drmTMB'
rho12(object, newdata = NULL, type = c("response", "link"), ...)

Arguments

object

A drmTMB fit.

...

Reserved for future extractor options.

newdata

Optional data frame for prediction.

type

Scale of returned values: "response" for correlation values or "link" for Fisher-z-like linear predictors.

Value

A numeric vector of residual correlations, or Fisher-z-like linear predictors when type = "link".