synthpop: summary.synds – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

summary.synds

Synthetic data object summaries

Description

Produces summaries of the synthesised variables. When more than one synthetic data set has been generated (object$m > 1), by default summaries are calculated by averaging summary values for all synthetic data copies (see msel argument).

Usage

## S3 method for class 'synds'
summary(object, msel = NULL, maxsum = 7, 
  digits = max(3, getOption("digits")-3), ...)

## S3 method for class 'summary.synds'
print(x, ...)

Arguments

`object`	an object of class `synds`; a result of a call to `syn`.
`msel`	index or indices of synthetic data copies for which a summary is desired. If `NULL` (default) summaries are calculated by averaging summary values for all synthetic data copies.
`maxsum`	integer, indicating how many levels should be shown for factors.
`digits`	integer, used for number formatting with `format`.
`...`	additional arguments passed to `summary`.
`x`	an object of class `summary.synds`.

Details

See summary for more details.

Value

An object of class summary.synds, which is a list with the following components:

`m`	the number of synthetic versions of the original (observed) data.
`msel`	index or indices of synthetic data copies for which a summary is produced. If `NULL` summaries are calculated by averaging summary values for all synthetic data copies.
`method`	a vector of synthesising methods applied to each variable in the saved synthesised data.
`result`	a table or a list of tabels (if more than one synthetic data set is selected) with summaries of synthesised variables.

References

Nowok, B., Raab, G.M and Dibben, C. (2016). synthpop: Bespoke creation of synthetic data in R. Journal of Statistical Software, 74(11), 1-26. doi: 10.18637/jss.v074.i11.

Examples

s1 <- syn(SD2011[,c("sex","age","edu","marital")], m = 3)
summary(s1)
summary(s1, msel = c(1,3))

synthpop

Generating Synthetic Versions of Sensitive Microdata for Statistical Disclosure Control

v1.6-0

GPL-2 | GPL-3

Authors

Beata Nowok [aut, cre], Gillian M Raab [aut], Chris Dibben [ctb], Joshua Snoke [ctb], Caspar van Lissa [ctb]

Initial release

2020-09-03