highlighted_alternative_table.Rd
Create a scenario overview with highlighted alternatives
highlighted_alternative_table( scores_per_alternative, alternativeLabels, decreasing = FALSE, scenarioDefinition = NULL, decisionOrder = NULL, decisionLabels = NULL, colNames = c("Decisions and alternatives", "Scores"), caption = NULL, estimateParseFunction = NULL, omitAlternativeLabelRegex = NULL, returnTableOnly = TRUE, ... )
scores_per_alternative | The `scorer_per_alternative` object as created by [compute_scores_per_alternative()]. |
---|---|
alternativeLabels | The `alternativeLabels` object. |
decreasing | Whether to sort the alternatives in decreasing order based on their final score. |
scenarioDefinition | The `scenarioDefinition` object to highlight; if omitted, no highlighting is done. |
decisionOrder | The vector with the decision identifiers to include (in the right order). |
decisionLabels | The named vector with the decision labels. |
colNames | The (two) column names to set in the resulting table. |
caption | The table caption to pass to [knitr::kable()]. |
estimateParseFunction | Optionally, a function that is called to parse the estimates before adding them to the table. |
omitAlternativeLabelRegex | A regular expression that can be used to omit one or more alternatives based on their labels. |
returnTableOnly | Whether to return the table only, or the full object that includes intermediate steps. |
... | Any additional arguments are passed on to `estimateParseFunction`. |