Skip to content

Commit 06d6281

Browse files
author
Florence Bockting
committed
refactor: clean-up refactoring and adjust for renamed arg
1 parent 3e1bf93 commit 06d6281

16 files changed

Lines changed: 746 additions & 411 deletions

R/loo-glossary.R

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -274,8 +274,8 @@
274274
#' analogue for means). Measures already returned on a utility scale (e.g. ELPD,
275275
#' CRPS/RPS) are not sign-flipped. Negative `m_diff` values then indicate worse
276276
#' performance than the reference model, which has `m_diff = 0` and
277-
#' `se_diff = 0`. Attribute `measure_revert_sign` on each `*_pred_measure()`
278-
#' result records whether `revert_sign` was applied when each measure was
277+
#' `se_diff = 0`. Attribute `measure_higher_is_better` on each `*_pred_measure()`
278+
#' result records the `higher_is_better` setting used when each measure was
279279
#' computed; when stored values are on a loss scale, `loo_compare()` emits a
280280
#' short message naming those measures (see [loo_compare()]).
281281
#'
@@ -287,13 +287,13 @@
287287
#' than a prefixed form. Only ELPD comparisons include `p_worse` and `diag_diff`;
288288
#' these diagnostics do not apply to other predictive measures.
289289
#'
290-
#' ### `measure_revert_sign`
290+
#' ### `measure_higher_is_better`
291291
#'
292292
#' Attribute on all `*_pred_measure()` and [pred_measure()] results: a named
293-
#' list of logicals recording whether `revert_sign` was applied when each
294-
#' measure was computed (`elpd` is always `FALSE`). Used by [loo_compare()] to
295-
#' decide whether paired differences for loss measures need an additional sign
296-
#' flip when converting to a utility scale.
293+
#' list recording the `higher_is_better` setting used for each measure (`NULL`,
294+
#' `TRUE`, or `FALSE`; `elpd` is always `NULL`). Used by [loo_compare()] with
295+
#' `measure_compare_meta` to decide whether paired differences need a sign flip
296+
#' when converting to a utility scale.
297297
#'
298298
#' ### `rank_by` and `compare_measures`
299299
#'

0 commit comments

Comments
 (0)