get_marginal_distributions: Generate Marginal Distributions for a given data frame

In RESIDE: Rapid Easy Synthesis to Inform Data Extraction

Generate Marginal Distributions for a given data frame

Description

Generate Marginal Distributions from a given data frame with options to specify which variables to use.

Usage

get_marginal_distributions(df, variables = c(), print = FALSE)

Arguments

df	Data frame to get the marginal distributions from
variables	(Optional) variable (columns) to select, Default: c()
print	Whether to print the marginal distributions to the console, Default: FALSE

Details

A function to generate marginal distributions from a given data frame, depending on the variable type the marginals will differ, for binary variables a mean and number of missing is generated for continuous variables, they are first transformed and both mean and sd of the transformed variables are stored along with the quantile mapping for back transformation. For categorical variables, the number of each category is stored, missing values are categorise as "missing".

Value

A list of marginal distributions of an S3 RESIDE Class

See Also

export_marginal_distributions

Examples

marginal_distributions <- get_marginal_distributions(
  IST,
  variables <- c(
    "SEX",
    "AGE",
    "ID14",
    "RSBP",
    "RATRIAL"
  )
)

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