copula_correlation

summary.sp_synthesizer

<code>copula_correlation()</code> returns the (latent) copula correlation matrix of a
fitted model, or with <code>what = "n_pair"</code> the number of rows on which each
pairwise estimate is based; <code><a href="/link/summary()?package=SynthesizerPlus&version=0.4.0" data-mini-rdoc="SynthesizerPlus::summary()">summary()</a></code> returns a table describing how
each column is modelled.

Generates synthetic versions of numeric, categorical, mixed-type
and time-series data. Marginal distributions are modelled with
interpolated empirical quantile functions and dependence with Gaussian or
Student-t copulas (Sklar, 1959). Discrete and categorical variables enter
the copula through the distributional transform (Ruschendorf, 2009,
<doi:10.1016/j.jspi.2009.05.030>), and their latent correlations are
estimated by maximum likelihood as polychoric (Olsson, 1979,
<doi:10.1007/BF02296207>) and polyserial (Olsson, Drasgow and Dorans,
1982, <doi:10.1007/BF02294164>) correlations. Unordered categories are
placed on their latent coordinate in an order estimated from their
association with the other variables. Missing values are
modelled by missingness indicators inside the copula, so that
missingness may depend on other variables. Supports stratified models,
a closeness parameter with calibration to a target distance or
disclosure-risk level, chunked generation of very large data sets,
optional hybrid copula and conditional CART or GAM synthesis for
one continuous response (requiring 'rpart' or 'mgcv'), training-only
automatic selection of the conditional engine, experimental nominal
conditional synthesis of one unordered categorical response (requiring
'nnet'), copula vector-autoregressive and bootstrap time-series synthesis,
augmentation of small training sets for machine learning, and random
generation from multivariate distributions and elliptical and
Archimedean copulas. Fidelity, utility and disclosure risk are assessed
with marginal distances, association matrices, propensity score
mean-squared error (Snoke et al., 2018, <doi:10.1111/rssa.12358>),
confidence-interval overlap, correct attribution probability and
distance to closest record, with 'ggplot2' visualisations. Data can be
read from and written to CSV, TSV, RDS, RData, Parquet, Feather, HDF5,
JSON, NDJSON, Excel, SPSS, Stata, SAS and fst files. The
empirical-quantile and copula approach builds on ideas of the
'synthesizer' package by Mark van der Loo.

Bogdan Oancea

SynthesizerPlus

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

copula_correlation function

<dl><dt>object</dt>
<dd>A fitted <code>sp_synthesizer</code>.</dd>
<dt>stratum</dt>
<dd>Optional stratum label for stratified models (as shown by
<code><a href="/link/summary()?package=SynthesizerPlus&version=0.4.0" data-mini-rdoc="SynthesizerPlus::summary()">summary()</a></code>); defaults to the pooled model.</dd>
<dt>include_missing</dt>
<dd>Include the missingness indicators in the matrix?</dd>
<dt>what</dt>
<dd><code>"correlation"</code> (default) or <code>"n_pair"</code> (an integer matrix of
jointly observed rows; the diagonal is the number of observed values).</dd>
<dt>...</dt>
<dd>Unused.</dd></dl>

Arguments

<code>copula_correlation()</code> returns the (latent) copula correlation matrix of a
fitted model, or with <code>what = "n_pair"</code> the number of rows on which each
pairwise estimate is based; <code><a href='https://rdrr.io/r/base/summary.html'>summary()</a></code> returns a table describing how
each column is modelled.

Inspect a fitted synthesizer — copula_correlation

<dl>

<dt>object</dt>
<dd>A fitted <code>sp_synthesizer</code>.</dd>


<dt>stratum</dt>
<dd>Optional stratum label for stratified models (as shown by
<code><a href='https://rdrr.io/r/base/summary.html'>summary()</a></code>); defaults to the pooled model.</dd>


<dt>include_missing</dt>
<dd>Include the missingness indicators in the matrix?</dd>


<dt>what</dt>
<dd><code>"correlation"</code> (default) or <code>"n_pair"</code> (an integer matrix of
jointly observed rows; the diagonal is the number of observed values).</dd>


<dt>...</dt>
<dd>Unused.</dd>

</dl>

copula_correlation: Inspect a fitted synthesizer

Description

Usage

Value

Arguments

Details

Examples