emoji_ratio() reports, per row, the share of the text's characters that
belong to emoji, and whether the text is emoji-only (nothing left after
removing emoji and whitespace). "Emoji-only" messages are a studied signal
in social-media research and a useful filter in practice.
Arguments
- data
A data frame or tibble containing a text column. Grouped data frames are accepted. The verbs that work a row at a time (adding columns, or keeping and expanding rows) carry the grouping through to their result, as
dplyr::mutate()anddplyr::filter()do. The verbs that pool across rows – the counts, the co-occurrence edge lists, the time series – warn that they ignore the grouping and return one corpus-wide answer.- text
The text column to scan, supplied unquoted. Any atomic column is accepted and read as character, so a
factorworks and a numeric,Dateor logical one simply contains no emoji. A list column – or a data-frame column – is refused rather than coerced, because coercing one deparses it and the emoji found would be in the code rather than in your data. What counts as an emoji is the same in every verb; see the Detection section of tidyEmoji for the one case that surprises people, code points that are emoji only when they carryU+FE0F.
Value
data, as a tibble, with added columns .emoji_ratio (emoji
characters / all characters, 0 when there are no emoji) and
.emoji_only (TRUE when the text contains emoji and nothing else but
whitespace). "Whitespace" is Unicode's White_Space property, written out
explicitly rather than left to the C library: it includes the no-break
spaces U+00A0 and U+202F and the ideographic space U+3000, and
excludes the zero-width space U+200B, which despite its name Unicode
does not classify as whitespace. The same set is used everywhere the
package splits or trims text, and it does not vary with the locale.
NA text gets NA in both. Empty text ("") has no
characters to take a share of, so .emoji_ratio is NA there too, but
.emoji_only is FALSE: an empty string is not a row of emoji.
Details
The ratio is computed over characters (code points), so a multi-code-point emoji (a ZWJ family, a skin-tone sequence) contributes all of its characters.
See also
emoji_position(), emoji_density(); emoji_filter() to keep
emoji-bearing rows.
Examples
df <- data.frame(text = c("\U0001f600\U0001f389", "half \U0001f600", "no"))
emoji_ratio(df, text)
#> # A tibble: 3 × 3
#> text .emoji_ratio .emoji_only
#> <chr> <dbl> <lgl>
#> 1 😀🎉 1 TRUE
#> 2 half 😀 0.167 FALSE
#> 3 no 0 FALSE