This function ranks each string in a character vector according to a
locale-dependent lexicographic order.
It is a portable replacement for the base xtfrm function.
Arguments
- str
a character vector
- ...
additional settings for
opts_collator- opts_collator
a named list with ICU Collator's options, see
stri_opts_collator,NULLfor default collation options
Details
Missing values result in missing ranks and tied observations receive the same ranks (based on min).
For more information on ICU's Collator and how to tune it up
in stringi, refer to stri_opts_collator.
References
Collation – ICU User Guide, https://unicode-org.github.io/icu/userguide/collation/
See also
The official online manual of stringi at https://stringi.gagolewski.com/
Gagolewski M., stringi: Fast and portable character string processing in R, Journal of Statistical Software 103(2), 2022, 1-59, doi:10.18637/jss.v103.i02
Other locale_sensitive:
%s<%(),
about_locale,
about_search_boundaries,
about_search_coll,
stri_compare(),
stri_count_boundaries(),
stri_duplicated(),
stri_enc_detect2(),
stri_extract_all_boundaries(),
stri_locate_all_boundaries(),
stri_opts_collator(),
stri_order(),
stri_sort(),
stri_sort_key(),
stri_split_boundaries(),
stri_trans_tolower(),
stri_unique(),
stri_wrap()
Author
Marek Gagolewski and other contributors
Examples
stri_rank(c('hladny', 'chladny'), locale='pl_PL')
#> [1] 2 1
stri_rank(c('hladny', 'chladny'), locale='sk_SK')
#> [1] 1 2
stri_rank("a" %s+% c(1, 100, 2, 101, 11, 10)) # lexicographic order
#> [1] 1 3 6 4 5 2
stri_rank("a" %s+% c(1, 100, 2, 101, 11, 10), numeric=TRUE) # OK
#> [1] 1 5 2 6 4 3
stri_rank("a" %s+% c(0.25, 0.5, 1, -1, -2, -3), numeric=TRUE) # incorrect
#> [1] 5 4 6 1 2 3
# Ordering a data frame with respect to two criteria:
X <- data.frame(a=c("b", NA, "b", "b", NA, "a", "a", "c"), b=runif(8))
X[order(stri_rank(X$a), X$b), ]
#> a b
#> 7 a 0.05083695
#> 6 a 0.97358461
#> 1 b 0.26292367
#> 4 b 0.44622483
#> 3 b 0.80585176
#> 8 c 0.80157442
#> 5 <NA> 0.04632583
#> 2 <NA> 0.33022216