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

exhibit-TTUProjectR Documentation

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

Description

exhibit method applied to TTUProject

Usage

## S4 method for signature 'TTUProject'
exhibit(
  x,
  captions_chr = NULL,
  display_1L_chr = "all",
  header_1L_chr = "",
  header_col_nms_chr = " ",
  mkdn_tbl_refs_chr = NULL,
  profile_idx_int = NA_integer_,
  output_type_1L_chr = "HTML",
  type_1L_chr = "default",
  use_lbls_as_col_nms_1L_lgl = T,
  use_rdocx_1L_lgl = F,
  variables_chr = character(0),
  what_1L_chr = "predictors",
  ...
)

Arguments

x

An object of class TTUProject

captions_chr

Captions (a character vector), Default: NULL

display_1L_chr

Display (a character vector of length one), Default: 'all'

header_1L_chr

Header (a character vector of length one), Default: ”

header_col_nms_chr

Header column names (a character vector), Default: ' '

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'

type_1L_chr

Type (a character vector of length one), Default: 'default'

use_lbls_as_col_nms_1L_lgl

Use labels as column names (a logical vector of length one), Default: T

use_rdocx_1L_lgl

Use rdocx (a logical vector of length one), Default: F

variables_chr

Variables (a character vector), Default: character(0)

what_1L_chr

What (a character vector of length one), Default: 'predictors'

...

Additional arguments

Value

No return value, called for side effects.


ready4-dev/TTU documentation built on July 2, 2024, 8:12 a.m.