exhibit-methods: Exhibit features of a dataset by printing them to the R...

In ready4-dev/specific: Specify Models to Solve Inverse Problems

Exhibit features of a dataset by printing them to the R console

Description

exhibit.specific_models() is an exhibit method that exhibits features of a class instance by printing to console. This method is implemented for the Candidate models lookup table The function is called for its side effects and does not return a value.

exhibit.specific_predictors() is an exhibit method that exhibits features of a class instance by printing to console. This method is implemented for the Candidate predictors lookup table The function is called for its side effects and does not return a value.

exhibit method applied to SpecificProject

Usage

exhibit.specific_models(
  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 'specific_models'
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,
  ...
)

exhibit.specific_predictors(
  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 'specific_predictors'
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 'SpecificProject'
exhibit(
  x,
  captions_chr = character(0),
  method_chr = c("pearson", "spearman"),
  mkdn_tbl_refs_chr = NULL,
  output_type_1L_chr = "HTML",
  timepoints_int = NA_integer_,
  type_1L_chr = "data",
  what_1L_chr = "correlation",
  ...
)

Arguments

x	An object of class SpecificProject
caption_1L_chr	Caption (a character vector of length one), Default: NULL
mkdn_tbl_ref_1L_chr	Markdown table reference (a character vector of length one), Default: NULL
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: T
...	Additional arguments
captions_chr	Captions (a character vector), Default: character(0)
method_chr	Method (a character vector), Default: c("pearson", "spearman")
mkdn_tbl_refs_chr	Markdown table references (a character vector), Default: NULL
timepoints_int	Timepoints (an integer vector), Default: NA
type_1L_chr	Type (a character vector of length one), Default: 'data'
what_1L_chr	What (a character vector of length one), Default: 'correlation'

ready4-dev/specific documentation built on Oct. 13, 2023, 7:54 a.m.