File: stri_info.Rd

package info (click to toggle)
r-cran-stringi 1.7.12-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 39,772 kB
  • sloc: cpp: 482,349; ansic: 51,900; perl: 471; makefile: 9; sh: 1
file content (48 lines) | stat: -rw-r--r-- 1,774 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ICU_settings.R
\name{stri_info}
\alias{stri_info}
\title{Query Default Settings for \pkg{stringi}}
\usage{
stri_info(short = FALSE)
}
\arguments{
\item{short}{logical; whether or not the results should be given
in a concise form; defaults to \code{TRUE}}
}
\value{
If \code{short} is \code{TRUE}, then a single string providing
information on the default character encoding, locale, and Unicode
as well as \pkg{ICU} version is returned.

Otherwise, a list with the following components is returned:
\itemize{
\item \code{Unicode.version} -- version of Unicode supported
by the \pkg{ICU} library;
\item \code{ICU.version} -- \pkg{ICU} library version used;
\item \code{Locale} -- contains information on default locale,
as returned by \code{\link{stri_locale_info}};
\item \code{Charset.internal} -- fixed at \code{c('UTF-8', 'UTF-16')};
\item \code{Charset.native} -- information on the default encoding,
as returned by \code{\link{stri_enc_info}};
\item \code{ICU.system} -- logical; \code{TRUE} indicates that
the system \pkg{ICU} libs are used, otherwise \pkg{ICU} was built together
with \pkg{stringi};
\item \code{ICU.UTF8} -- logical; \code{TRUE} if the internal
\code{U_CHARSET_IS_UTF8} flag is defined and set.
}
}
\description{
Gives the current default settings used by the \pkg{ICU} library.
}
\concept{encoding}
\concept{locale}
\author{
\href{https://www.gagolewski.com/}{Marek Gagolewski} and other contributors
}
\seealso{
The official online manual of \pkg{stringi} at \url{https://stringi.gagolewski.com/}

Gagolewski M., \pkg{stringi}: Fast and portable character string processing in R, \emph{Journal of Statistical Software} 103(2), 2022, 1-59, \doi{10.18637/jss.v103.i02}

}