copula_correlation: Inspect a fitted synthesizer

In SynthesizerPlus: Synthetic Data Generation with Copulas, Evaluation and Multi-Format I/O

Inspect a fitted synthesizer

Description

copula_correlation() returns the (latent) copula correlation matrix of a fitted model, or with what = "n_pair" the number of rows on which each pairwise estimate is based; summary() returns a table describing how each column is modelled.

Usage

copula_correlation(
  object,
  stratum = NULL,
  include_missing = FALSE,
  what = c("correlation", "n_pair")
)

## S3 method for class 'sp_synthesizer'
summary(object, ...)

Arguments

object	A fitted sp_synthesizer.
stratum	Optional stratum label for stratified models (as shown by summary()); defaults to the pooled model.
include_missing	Include the missingness indicators in the matrix?
what	"correlation" (default) or "n_pair" (an integer matrix of jointly observed rows; the diagonal is the number of observed values).
...	Unused.

Details

A pairwise correlation is treated as unidentified when the two variables are observed together in fewer than 3 rows, or when its estimate is not finite (a numerical safeguard). Such entries are not estimated from data but completed as described in the "Estimation details" section of fit_synthesizer(); n_pair alone therefore does not identify all of them.

Value

copula_correlation(): a correlation matrix (or a count matrix for what = "n_pair"). summary(): an object of class summary.sp_synthesizer (a list with a columns data frame).

Examples

fit <- fit_synthesizer(airquality)
round(copula_correlation(fit), 2)
summary(fit)

SynthesizerPlus documentation built on Oct. 16, 2026, 5:10 p.m.