q3FromRes: Extracts the Q3 matrices from the object returned by...

View source: R/fromRes.R

q3FromResR Documentation

Extracts the Q3 matrices from the object returned by getResults()

Description

Collects Q3 matrices in a list of data frames.

Usage

q3FromRes(resultsObj, out = c("wide", "long" ), triangular = FALSE)

Arguments

resultsObj

The object returned by getResults.

out

Specifies the output format. "wide" gives a triangular matrix, "long" gives a long format table with the residual correlation in a separate column.

triangular

Logical: should the wide-format matrix be arranged in triangular shape?

Value

A list of data frames, one data.frame per model.

Examples

### read exemplary results object
file <- system.file("extdata", "results.rda", package = "eatModel")
load(file)
q3   <- q3FromRes(res)

weirichs/eatModel documentation built on Jan. 26, 2025, 4:01 p.m.