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

In ready4-dev/ready4use: Ingest, Label, Visualise and Share Health Economic Model Datasets

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

Description

exhibit.ready4use_dictionary() is an exhibit method that exhibits features of a class instance by printing to console. This method is implemented for the ready4 s3 class defining a data dictionary tibble. The function is called for its side effects and does not return a value.

exhibit method applied to Ready4useDyad

Usage

exhibit.ready4use_dictionary(
  x,
  caption_1L_chr = NULL,
  mkdn_tbl_ref_1L_chr = NULL,
  output_type_1L_chr = "HTML",
  use_lbls_as_col_nms_1L_lgl = T
)

## S4 method for signature 'ready4use_dictionary'
exhibit(
  x,
  caption_1L_chr = NULL,
  mkdn_tbl_ref_1L_chr = NULL,
  output_type_1L_chr = "HTML",
  use_lbls_as_col_nms_1L_lgl = T
)

## S4 method for signature 'Ready4useDyad'
exhibit(
  x,
  caption_1L_chr = NA_character_,
  display_1L_chr = "all",
  label_1L_lgl = FALSE,
  mkdn_tbl_ref_1L_chr = "",
  output_type_1L_chr = "HTML",
  type_1L_chr = "ds",
  use_lbls_as_col_nms_1L_lgl = TRUE,
  use_rdocx_1L_lgl = FALSE,
  ...
)

Arguments

x	An object of class Ready4useDyad
caption_1L_chr	Caption (a character vector of length one), Default: 'NA'
mkdn_tbl_ref_1L_chr	Markdown table reference (a character vector of length one), Default: ”
output_type_1L_chr	Output type (a character vector of length one), Default: 'HTML'
use_lbls_as_col_nms_1L_lgl	Use labels as column names (a logical vector of length one), Default: TRUE
display_1L_chr	Display (a character vector of length one), Default: 'all'
label_1L_lgl	Label (a logical vector of length one), Default: FALSE
type_1L_chr	Type (a character vector of length one), Default: 'ds'
use_rdocx_1L_lgl	Use rdocx (a logical vector of length one), Default: FALSE
...	Additional arguments

Value

No return value, called for side effects.

No return value, called for side effects.

ready4-dev/ready4use documentation built on June 1, 2025, 2:06 p.m.