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

# stri_escape_unicode: Escape Unicode Code Points

## Description

Generates an ASCII string where all non-printable characters and non-ASCII characters are converted to escape sequences.

## Usage

    stri_escape_unicode(str)

## Arguments

`str` | character vector

## Details

For non-printable and certain special (well-known, see also the R man page Quotes) ASCII characters, the following (also recognized in R) convention is used. We get `\a`, `\b`, `\t`, `\n`, `\v`, `\f`, `\r`, `\"`, `\'`, `\\` or either `\uXXXX` (4 hex digits) or `\UXXXXXXXX` (8 hex digits) otherwise.

As usual in stringi, any input string is converted to Unicode before executing the escape process.

## Value

Returns a character vector.

## 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 escape: `stri_unescape_unicode()`

## Examples

    stri_escape_unicode('a\u0105!')
    ## [1] "a\\u0105!"