R: Split a string into emoji and non-emoji glyph runs

str_split_emoji {systemfonts} | R Documentation

## Split a string into emoji and non-emoji glyph runs

### Description

In order to do correct text rendering, the font needed must be figured out. A common case is rendering of emojis within a string where the system emoji font is used rather than the requested font. This function will inspect the provided strings and split them up in runs that must be rendered with the emoji font, and the rest. Arguments are recycled to the length of the `string` vector.

### Usage

    str_split_emoji(
      string,
      family = "",
      italic = FALSE,
      bold = FALSE,
      path = NULL,
      index = 0
    )

### Arguments

`string` | A character vector of strings that should be splitted.
`family` | The name of the font family
`italic` | logicals indicating the font style
`bold` | logicals indicating the font style
`path, index` | path an index of a font file to circumvent lookup based on family and style

### Value

A data.frame containing the following columns:

string

  The substring containing a consecutive run of glyphs

id

  The index into the original `string` vector that the substring is part of

emoji

  A logical vector giving if the substring is a run of emojis or not

### Examples

    emoji_string <- "This is a joke\U0001f642. It should be obvious from the smiley"
    str_split_emoji(emoji_string)

[Package systemfonts version 1.0.2 Index]