Hide navigation sidebar
Hide table of contents sidebar
Back to top
Edit this page
Toggle table of contents sidebar

# stri_locale_info: Query Given Locale

## Description

Provides some basic information on a given locale identifier.

## Usage

    stri_locale_info(locale = NULL)

## Arguments

`locale` | `NULL` or `''` for default locale, or a single string with locale identifier.

## Details

With this function you may obtain some basic information on any provided locale identifier, even if it is unsupported by ICU or if you pass a malformed locale identifier (the one that is not, e.g., of the form Language_Country). See stringi-locale for discussion.

This function does not do anything really complicated. In many cases it is similar to a call to [`as.list(``stri_split_fixed``(locale, '_', 3L)[[1]])`](https://stat.ethz.ch/R-manual/R-devel/library/base/html/list.html), with `locale` case mapped. It may be used, however, to get insight on how ICU understands a given locale identifier.

## Value

Returns a list with the following named character strings: `Language`, `Country`, `Variant`, and `Name`, being their underscore separated combination.

## Author(s)

Marek Gagolewski and other contributors

## 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_management: `about_locale`, `stri_locale_list()`, `stri_locale_set()`

## Examples

    stri_locale_info('pl_PL')
    ## $Language
    ## [1] "pl"
    ##
    ## $Country
    ## [1] "PL"
    ##
    ## $Variant
    ## [1] ""
    ##
    ## $Name
    ## [1] "pl_PL"
    stri_locale_info('Pl_pL') # the same result
    ## $Language
    ## [1] "pl"
    ##
    ## $Country
    ## [1] "PL"
    ##
    ## $Variant
    ## [1] ""
    ##
    ## $Name
    ## [1] "pl_PL"