DEXiR (version 1.0.2)

compare_values_by_preference: compare_values_by_preference

Description

Compare values, considering preference order. For value arguments, see compare_values().

Usage

compare_values_by_preference(value1, value2, order = EnumOrder)

Value

compare_values() result, modified according to order. Results 0 (equal values) and NA (incomparable values) are always retained. Results -1 and +1 are retained when order="ascending" and reversed when order="descending". When order="none", non-equal values return NA.

Arguments

value1

First value.

value2

Second value.

order

EnumOrder, i.e., one of the strings "ascending", "descending", "none".

See Also

compare_values()

Examples

compare_values_by_preference(1, 1, "none")       # 0
compare_values_by_preference(1, 2, "none")       # NA
compare_values_by_preference(3, 2, "none")       # NA
compare_values_by_preference(1, 1, "ascending")  # 0
compare_values_by_preference(1, 2, "ascending")  # -1
compare_values_by_preference(3, 2, "ascending")  # +1
compare_values_by_preference(1, 1, "descending") # 0
compare_values_by_preference(1, 2, "descending") # +1
compare_values_by_preference(3, 2, "descending") # -1