print.RESIDE: print.RESIDE

View source: R/print.RESIDE.R

print.RESIDER Documentation

print.RESIDE

Description

S3 override for print RESIDE

Usage

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

Arguments

x

an object of class RESIDE

...

Other parameters, full = TRUE prints every category of the categorical variables, Default: FALSE

Details

S3 Override for RESIDE Class, prints the overall summary followed by the marginal distributions of each data frame. By default categorical variables with more than 10 categories only print the 10 most common categories, use full = TRUE to print every category.

Value

The RESIDE object, invisibly. Called to print to the terminal.

Examples

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

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