| Type: | Package |
| Title: | Interactively Insert Emojis in 'R' Documents |
| Version: | 0.1.0 |
| Maintainer: | Berhe Etsay Tesfay <berhe.etsay@gmail.com> |
| Description: | Provides an intuitive and user-friendly interface for working with emojis in 'R'. It allows users to search, insert, and manage emojis by keyword, category, or through an interactive 'shiny'-based drop-down. The package enables integration of emojis into 'R' scripts, 'R Markdown', 'Quarto', 'shiny' apps, and 'ggplot2' plots. Also includes built-in mappings for commit messages, useful for version control. It builds on established emoji libraries and Unicode standards, adding expressiveness and visual cues to documentation, user interfaces, and reports. For more details see 'Emojipedia' (2024) https://emojipedia.org and GitHub Emoji Cheat Sheet https://github.com/ikatyang/emoji-cheat-sheet/tree/master. |
| License: | MIT + file LICENSE |
| Encoding: | UTF-8 |
| LazyData: | true |
| RoxygenNote: | 7.3.2 |
| Depends: | R (≥ 4.4) |
| Imports: | rstudioapi, shiny, shinyjs |
| Suggests: | knitr, rmarkdown, testthat (≥ 3.0.0), mockery, devtools |
| URL: | https://github.com/3p1d3m/Rmoji |
| BugReports: | https://github.com/3p1d3m/Rmoji/issues |
| Config/testthat/edition: | 3 |
| VignetteBuilder: | knitr |
| NeedsCompilation: | no |
| Packaged: | 2025-04-25 11:50:18 UTC; berhe |
| Author: | Berhe Etsay Tesfay
 [aut, cre] |
| Repository: | CRAN |
| Date/Publication: | 2025-04-25 15:20:06 UTC |
Emoji Master List
Description
A list of emoji Unicode values with human-friendly names.
Usage
data(emoji_dict)
Format
A named list of emoji names and corresponding Unicode symbols.
Examples
data(emoji_dict)
head(emoji_dict)
Print list of All Available Emoji names and actual emojis in the console
Description
Prints all emoji names with their corresponding emoji symbols from the master list.
Usage
emoji_list()
Value
prints the name of the emoji and the emoji image in the console
Examples
emoji_list()
Emoji Shortcut Function (to work with keyboard shortcut)
Description
Designed to be bound to a keyboard shortcut.
Usage
emoji_shortcut()
Value
Opens addin popup for emoji selection.
Examples
if (interactive()) {
emoji_shortcut()
}
Emoji for Git Commit message with emoji
Description
Get emoji(s) for Git commit messages by name.
Usage
git_emoji(name)
Arguments
name |
A character vector of emoji names (e.g., |
Value
A named character vector of emojis.
Examples
git_emoji("fire")
git_emoji(c("fire", "heart"))
try(git_emoji(c("Ethiopia", "UK", "Kenya")))
Insert Emoji into R Script using a function
Description
Inserts an emoji by name from the emoji_dict through writing the function in the cursor position of the Rstudio Document.
Usage
insert_emoji(name, default = NULL)
Arguments
name |
The name of the emoji (case-insensitive). |
default |
A default emoji to use if the name is not found. |
Value
The emoji used (invisibly).
Examples
if (interactive()) {
insert_emoji("smile")
insert_emoji("notarealemoji", default = "?")
}
For an R studio addin dropdown to insert emoji
Description
For an R studio addin dropdown to insert emoji
Usage
insert_emoji_addin(test_input = NULL)
Arguments
test_input |
For internal testing. If supplied, this will be used instead of prompting the user. |
Value
Inserted emoji or NULL
Shiny app with drop-down option, it runs from addins and using shortcut.
Description
This RStudio addin allows users to easily insert emojis by name into their R scripts, R Markdown, or Quarto documents. A Shiny-based GUI with a searchable dropdown will appear, allowing the user to select an emoji. Once an emoji is selected, it will be inserted at the cursor's position in the active editor.
Usage
shiny_emoji()
Value
Inserts the selected emoji at the cursor position in the active R script or R Markdown document.
Examples
if (interactive()) {
shiny_emoji()
}
# Use this addin by running shiny_emoji() from the RStudio Addins menu.