Awesome

utf8

utf8 is an R package for manipulating and printing UTF-8 text that fixes multiple bugs in R’s UTF-8 handling.

Installation

Stable version

utf8 is available on CRAN. To install the latest released version, run the following command in R:

<pre class='chroma'> <a href='https://rdrr.io/r/utils/install.packages.html'>install.packages</a>("utf8")</pre>

Development version

To install the latest development version, run the following:

<pre class='chroma'> devtools::<a href='https://devtools.r-lib.org//reference/remote-reexports.html'>install_github</a>("patperry/r-utf8")</pre>

Usage

<pre class='chroma'> <a href='https://rdrr.io/r/base/library.html'>library</a>(<a href='https://github.com/patperry/r-utf8'>utf8</a>)</pre>

Validate character data and convert to UTF-8

Use as_utf8() to validate input text and convert to UTF-8 encoding. The function alerts you if the input text has the wrong declared encoding:

<pre class='chroma'> # second entry is encoded in latin-1, but declared as UTF-8 x <- <a href='https://rdrr.io/r/base/c.html'>c</a>("fa\u00E7ile", "fa\xE7ile", "fa\xC3\xA7ile") <a href='https://rdrr.io/r/base/Encoding.html'>Encoding</a>(x) <- <a href='https://rdrr.io/r/base/c.html'>c</a>("UTF-8", "UTF-8", "bytes") <a href='https://rdrr.io/pkg/utf8/man/as_utf8.html'>as_utf8</a>(x) # fails #> Error in as_utf8(x): entry 2 has wrong Encoding; marked as "UTF-8" but leading byte 0xE7 followed by invalid continuation byte (0x69) at position 4 # mark the correct encoding <a href='https://rdrr.io/r/base/Encoding.html'>Encoding</a>(x[2]) <- "latin1" <a href='https://rdrr.io/pkg/utf8/man/as_utf8.html'>as_utf8</a>(x) # succeeds #> [1] "façile" "façile" "façile"</pre>

Normalize data

Use utf8_normalize() to convert to Unicode composed normal form (NFC). Optionally apply compatibility maps for NFKC normal form or case-fold.

<pre class='chroma'> # three ways to encode an angstrom character (angstrom <- <a href='https://rdrr.io/r/base/c.html'>c</a>("\u00c5", "\u0041\u030a", "\u212b")) #> [1] "Å" "Å" "Å" <a href='https://rdrr.io/pkg/utf8/man/utf8_normalize.html'>utf8_normalize</a>(angstrom) == "\u00c5" #> [1] TRUE TRUE TRUE # perform full Unicode case-folding <a href='https://rdrr.io/pkg/utf8/man/utf8_normalize.html'>utf8_normalize</a>("Größe", map_case = TRUE) #> [1] "grösse" # apply compatibility maps to NFKC normal form # (example from https://twitter.com/aprilarcus/status/367557195186970624) <a href='https://rdrr.io/pkg/utf8/man/utf8_normalize.html'>utf8_normalize</a>("𝖸𝗈 𝐔𝐧𝐢𝐜𝐨𝐝𝐞 𝗅 𝗁𝖾𝗋𝖽 𝕌 𝗅𝗂𝗄𝖾 𝑡𝑦𝑝𝑒𝑓𝑎𝑐𝑒𝑠 𝗌𝗈 𝗐𝖾 𝗉𝗎𝗍 𝗌𝗈𝗆𝖾 𝚌𝚘𝚍𝚎𝚙𝚘𝚒𝚗𝚝𝚜 𝗂𝗇 𝗒𝗈𝗎𝗋 𝔖𝔲𝔭𝔭𝔩𝔢𝔪𝔢𝔫𝔱𝔞𝔯𝔶 𝔚𝔲𝔩𝔱𝔦𝔩𝔦𝔫𝔤𝔳𝔞𝔩 𝔓𝔩𝔞𝔫𝔢 𝗌𝗈 𝗒𝗈𝗎 𝖼𝖺𝗇 𝓮𝓷𝓬𝓸𝓭𝓮 𝕗𝕠𝕟𝕥𝕤 𝗂𝗇 𝗒𝗈𝗎𝗋 𝒇𝒐𝒏𝒕𝒔.", map_compat = TRUE) #> [1] "Yo Unicode l herd U like typefaces so we put some codepoints in your Supplementary Wultilingval Plane so you can encode fonts in your fonts."</pre>

Print emoji

On some platforms (including MacOS), the R implementation of print() uses an outdated version of the Unicode standard to determine which characters are printable. Use utf8_print() for an updated print function:

<pre class='chroma'> <a href='https://rdrr.io/r/base/print.html'>print</a>(<a href='https://rdrr.io/r/base/utf8Conversion.html'>intToUtf8</a>(0x1F600 + 0:79)) # with default R print function #> [1] "😀😁😂😃😄😅😆😇😈😉😊😋😌😍😎😏😐😑😒😓😔😕😖😗😘😙😚😛😜😝😞😟😠😡😢😣😤😥😦😧😨😩😪😫😬😭😮😯😰😱😲😳😴😵😶😷😸😹😺😻😼😽😾😿🙀🙁🙂🙃🙄🙅🙆🙇🙈🙉🙊🙋🙌🙍🙎🙏" <a href='https://rdrr.io/pkg/utf8/man/utf8_print.html'>utf8_print</a>(<a href='https://rdrr.io/r/base/utf8Conversion.html'>intToUtf8</a>(0x1F600 + 0:79)) # with utf8_print, truncates line #> [1] "😀😁😂😃😄😅😆😇😈😉😊😋😌😍😎😏😐😑😒😓😔😕😖😗😘😙😚😛😜😝😞😟😠😡😢😣😤😥😦😧😨😩😪😫…" <a href='https://rdrr.io/pkg/utf8/man/utf8_print.html'>utf8_print</a>(<a href='https://rdrr.io/r/base/utf8Conversion.html'>intToUtf8</a>(0x1F600 + 0:79), chars = 1000) # higher character limit #> [1] "😀😁😂😃😄😅😆😇😈😉😊😋😌😍😎😏😐😑😒😓😔😕😖😗😘😙😚😛😜😝😞😟😠😡😢😣😤😥😦😧😨😩😪😫😬😭😮😯😰😱😲😳😴😵😶😷😸😹😺😻😼😽😾😿🙀🙁🙂🙃🙄🙅🙆🙇🙈🙉🙊🙋🙌🙍🙎🙏"</pre>

Citation

Cite utf8 with the following BibTeX entry:

@Manual{,
  title = {utf8: Unicode Text Processing},
  author = {Patrick O. Perry},
  year = {2018},
  note = {R package version 1.1.4},
  url = {https://github.com/patperry/r-utf8},
}

Contributing

The project maintainer welcomes contributions in the form of feature requests, bug reports, comments, unit tests, vignettes, or other code. If you’d like to contribute, either

fork the repository and submit a pull request
file an issue;
or contact the maintainer via e-mail.

This project is released with a Contributor Code of Conduct, and if you choose to contribute, you must adhere to its terms.