coef.tridim_transformation: Posterior distributions for transformation coefficients in...

View source: R/coef.R

coef.tridim_transformationR Documentation

Posterior distributions for transformation coefficients in full or summarized form.

Description

Posterior distributions for transformation coefficients in full or summarized form.

Usage

## S3 method for class 'tridim_transformation'
coef(
  object,
  summary = TRUE,
  probs = c(0.055, 0.945),
  convert_euclidean = FALSE,
  ...
)

Arguments

object

An object of class tridim_transformation.

summary

Whether summary statistics should be returned instead of raw sample values. Defaults to TRUE

probs

The percentiles used to compute summary, defaults to 89% credible interval.

convert_euclidean

Whether to convert matrix coefficients to scale(phi) and rotation(theta). Defaults to FALSE.

...

Unused

Value

If summary=FALSE, a list with matrix iterationsN x dimensionsN for each variable. If summary=TRUE, a data.frame with columns "dvindex" with mean for each dependent variable plus optional quantiles columns with names "dvindex_quantile".

Examples

euc2 <- fit_transformation(depV1+depV2~indepV1+indepV2,
                           data = NakayaData,
                           transformation = 'euclidean')

# full posterior distribution
transform_posterior <- coef(euc2, summary=FALSE)

# coefficients' summary with 89% CI
coef(euc2)

# scale and rotation coefficients
coef(euc2, convert_euclidean=TRUE)

TriDimRegression documentation built on Sept. 13, 2023, 5:07 p.m.