exhibit-methods: Exhibit features of model module data by printing them to the...

In ready4-dev/youthvars: Describe and Validate Youth Mental Health Economic Datasets

Exhibit features of model module data by printing them to the R console

Description

exhibit method applied to YouthvarsSeries

exhibit method applied to YouthvarsProfile

Usage

## S4 method for signature 'YouthvarsSeries'
exhibit(
  x,
  captions_chr = NULL,
  mkdn_tbl_refs_chr = NULL,
  profile_idx_int = NA_integer_,
  output_type_1L_chr = "HTML",
  timepoints_int = c(1L, 2L),
  type_1L_chr = "characterize",
  what_1L_chr = "descriptives",
  ...
)

## S4 method for signature 'YouthvarsProfile'
exhibit(
  x,
  captions_chr = NULL,
  header_1L_chr = "",
  header_col_nms_chr = " ",
  mkdn_tbl_refs_chr = NULL,
  profile_idx_int = NA_integer_,
  output_type_1L_chr = "HTML",
  what_1L_chr = "descriptives",
  ...
)

Arguments

x	An object of class YouthvarsProfile
captions_chr	Captions (a character vector), Default: NULL
mkdn_tbl_refs_chr	Markdown table references (a character vector), Default: NULL
profile_idx_int	Profile index (an integer vector), Default: NA
output_type_1L_chr	Output type (a character vector of length one), Default: 'HTML'
timepoints_int	Timepoints (an integer vector), Default: c(1L, 2L)
type_1L_chr	Type (a character vector of length one), Default: 'characterize'
what_1L_chr	What (a character vector of length one), Default: 'descriptives'
...	Additional arguments
header_1L_chr	Header (a character vector of length one), Default: ”
header_col_nms_chr	Header column names (a character vector), Default: ' '

Value

No return value, called for side effects.

No return value, called for side effects.

ready4-dev/youthvars documentation built on Nov. 15, 2024, 6:02 a.m.