Learn R Programming

rpact (version 5.0.0)

getComparisonParameterDescriptions: Describe Comparison Parameters

Description

Formats comparison parameter metadata for console output, summaries, and UI labels. Formatting does not alter the metadata or comparison data.

Usage

getComparisonParameterDescriptions(
  parameterInfo,
  ...,
  digits = NA_integer_,
  showDetails = TRUE
)

Value

A character vector named by parameter names. Empty input returns character(). Empty columns are described as empty, not as single-valued.

Arguments

parameterInfo

A comparison parameter metadata table, as available in summary(comparison)$parameterInfo, or a row subset of such a table.

...

Further arguments. Currently unused.

digits

Optional number of decimal places for displayed values.

showDetails

Whether to include the inferred type and plotting role.

Examples

Run this code
comparison <- getComparison(getDesignFixed(), getDesignGroupSequential(kMax = 2))
info <- summary(comparison)$parameterInfo
getComparisonParameterDescriptions(info)

Run the code above in your browser using DataLab