A snapshot of comparison profiles and display settings, created by
summary.TrialComparison() or compare().
parameterInfoA data frame of derived parameter metadata, exact profiles and object group IDs, with one row per comparison parameter. Profiles retain their stage and situation coordinates.
digitsNumber of digits supplied for display rounding; NA leaves values unrounded. Is a single numeric value representing a whole number.
maxParametersMaximum number of differing parameters displayed; defaults to 12. Ignored for display when showAll is TRUE. Is a single numeric value representing a whole number.
maxProfilesMaximum number of distinct profiles displayed per parameter; defaults to 3. Ignored for display when showAll is TRUE. Is a single numeric value representing a whole number.
maxObjectsMaximum number of object names or numbers displayed per profile; defaults to 6. Ignored for display when showAll is TRUE. Is a single numeric value representing a whole number.
maxValuesMaximum number of values displayed per profile preview; defaults to 4. Ignored for display when showAll is TRUE. Is a single numeric value representing a whole number.
maxTableColumnsMaximum result/profile columns per Markdown table block, excluding coordinate columns; defaults to 4. Applies also when showAll is TRUE; does not limit displayed data or affect console output. Is a single numeric value representing a whole number.
harmonizeColumnNamesWhether the snapshot uses harmonized comparison column names; defaults to TRUE. Is a single logical value.
textModeResolved console text handling: wrap, truncate or full. Defaults to wrap; showAll disables truncation without changing this stored input. Is a single character value.
widthResolved console line width in characters, at least 20. Taken from the supplied value, comparison setting or the R width option (fallback 80). Is a single numeric value representing a whole number.
showAllWhether all profiles, objects and values are displayed without the max limits or text truncation; defaults to FALSE. Stored limits remain unchanged. Is a single logical value.
showDataTypeWhether parameter headings include data type descriptions in console and Markdown output; defaults to FALSE. Independent of showAll. Is a single logical value.
objectThe underlying TrialComparison object, retained by reference.
titleDerived comparison summary title. Is a single character value.
headerInherited optional summary header; NULL for comparison summaries.
summaryItemsInherited list of summary items; empty for comparison summaries, which render parameterInfo directly.
intervalFormatInherited interval format string, initially [%s; %s]; comparison profile rendering does not use this field. Is a single character value.
justifyInherited alignment setting resolved from the summary configuration, with default right. Is a single character value.
outputSelected summary sections: all, title, overview or body; defaults to all. Is a single character value.
markdownInherited Markdown output flag, initially FALSE. Is a single logical value.
Inherits from SummaryFactory and ParameterSet. Each resolved summary
input is classified centrally as a default or user-defined parameter.
getObjectRCode() includes only user-defined inputs unless
includeDefaultParameters = TRUE. Settings resolved from R options or
environment variables are retained when they differ from package defaults.
showAll affects rendering without replacing the stored limits or text mode.
Markdown tables place coordinates in rows and profiles in columns, using at
most maxTableColumns profile columns per block even with showAll = TRUE.
Coordinate columns repeat in each block. Scalar profiles use one-row tables.
Long profile labels are listed above the tables with short column references.
Profiles with incompatible dimensions are displayed in separate tables.
The underlying comparison is retained by reference, whereas profiles and
display labels are snapshots. Recompute the summary after changing objects.
getComparison(), compare()