This function computes a locale-dependent sort key, which is an alternative
character representation of the string that, when ordered in the C locale
(which orders using the underlying bytes directly), will give an equivalent
ordering to the original string. It is useful for enhancing algorithms
that sort only in the C locale (e.g., the strcmp function in libc)
with the ability to be locale-aware.
Usage
stri_sort_key(str, ..., opts_collator = NULL)
Arguments
str
a character vector
...
additional settings for opts_collator
opts_collator
a named list with ICU Collator's options,
see stri_opts_collator, NULL
for default collation options
Value
The result is a character vector with the same length as str that
contains the sort keys. The output is marked as bytes-encoded.
Details
For more information on ICU's Collator and how to tune it up
in stringi, refer to stri_opts_collator.
See also stri_rank for ranking strings with a single character
vector, i.e., generating relative sort keys.