This function finds a permutation which rearranges the
strings in a given character vector into the ascending or descending
locale-dependent lexicographic order.
The function yields an integer vector that gives the sort order.
Arguments
str
a character vector
decreasing
a single logical value; should the sort order
be nondecreasing (FALSE, default)
or nonincreasing (TRUE)?
na_last
a single logical value; controls the treatment of NAs
in str. If TRUE, then missing values in str are put
at the end; if FALSE, they are put at the beginning;
if NA, then they are removed from the output
...
additional settings for opts_collator
opts_collator
a named list with ICU Collator's options,
see stri_opts_collator, NULL
for default collation options
For more information on ICU's Collator and how to tune it up
in stringi, refer to stri_opts_collator.
As usual in stringi, non-character inputs are coerced to strings,
see an example below for a somewhat non-intuitive behavior of lexicographic
sorting on numeric inputs.
This function uses a stable sort algorithm (STL's stable_sort),
which performs up to \(N*log^2(N)\) element comparisons,
where \(N\) is the length of str.
For ordering with regards to multiple criteria (such as sorting
data frames by more than 1 column), see stri_rank.