synthesise_data: Synthesise data from marginal distributions

In RESIDE: Rapid Easy Synthesis to Inform Data Extraction

Synthesise data from marginal distributions

Description

Allows the synthesis of data from marginal distributions obtained from a Trusted Research Environment (TRE)

Usage

synthesise_data(marginals, correlation_matrix = NULL, ...)

synthesize_data(marginals, correlation_matrix = NULL, ...)

Arguments

marginals	an object of class RESIDE
correlation_matrix	Correlation Matrix see export_empty_cor_matrix and import_cor_matrix, Default: NULL
...	Additional parameters currently none are used.

Details

This function will synthesise a dataset from marginals imported using import_marginal_distributions. By default the dataset will not contain correlations, however user specified correlations can be added using the correlation_matrix parameter, see export_empty_cor_matrix and import_cor_matrix for more details.

Value

a data frame of simulated data

See Also

export_empty_cor_matrix import_cor_matrix

Examples

## Not run: 
   marginals <- import_marginal_distributions()
   df <- synthesise_data(marginals)

## End(Not run)

RESIDE documentation built on Oct. 18, 2024, 1:07 a.m.