added examples

Author: Youzhi Yu

R/emoji-categorize.R

@@ -22,19 +22,31 @@ emoji_category_add <- function(emoji_unicodes, emoji_category, tweet_tbl, tweet_
 #' @return A filtered dataframe with the presence of Emoji only, and with an
 #' extra column \code{.emoji_category}.
 #' @export
-#'
+#' @examples
+#' library(dplyr)
+#' data.frame(tweets = c("I love tidyverse \U0001f600\U0001f603\U0001f603",
+#'                       "R is my language! \U0001f601\U0001f606\U0001f605",
+#'                       "This Tweet does not have Emoji!",
+#'                       "Wearing a mask\U0001f637\U0001f637\U0001f637.",
+#'                       "Emoji does not appear in all Tweets",
+#'                       "A flag \U0001f600\U0001f3c1")) %>%
+#'          emoji_categorize(tweets)
 
 
 emoji_categorize <- function(tweet_tbl, tweet_text) {
 
-  purrr::map2_dfr(tidyEmoji::category_unicode_crosswalk$unicodes,
-           tidyEmoji::category_unicode_crosswalk$category,
-           emoji_category_add,
-           tweet_tbl,
-           {{ tweet_text }}) %>%
+  emoji_long <- purrr::map2_dfr(tidyEmoji::category_unicode_crosswalk$unicodes,
+                  tidyEmoji::category_unicode_crosswalk$category,
+                  emoji_category_add,
+                  tweet_tbl,
+                  {{ tweet_text }})
+
+  emoji_category_vector <- unique(emoji_long$.emoji_category)
+
+  emoji_long %>%
     tidyr::pivot_wider(names_from = .emoji_category,
                        values_from = .emoji_category) %>%
-    tidyr::unite(".emoji_category", c("Smileys & Emotion": "Flags"), sep = "|", na.rm = T)
+    tidyr::unite(".emoji_category", emoji_category_vector, sep = "|", na.rm = T)
 
 
 }

R/emoji-extraction.R

@@ -12,7 +12,18 @@
 #' @import tidyr
 #' @return A summary tibble with the original row number and Emoji count.
 #' @export
+#' @examples
+#' library(dplyr)
+#' data.frame(tweets = c("I love tidyverse \U0001f600\U0001f603\U0001f603",
+#'                       "R is my language! \U0001f601\U0001f606\U0001f605",
+#'                       "This Tweet does not have Emoji!",
+#'                       "Wearing a mask\U0001f637\U0001f637\U0001f637.",
+#'                       "Emoji does not appear in all Tweets",
+#'                       "A flag \U0001f600\U0001f3c1")) %>%
+#'          emoji_extract_unnest(tweets)
 #'
+
+
 emoji_extract_unnest <- function(tweet_tbl, tweet_text){
   tweet_tbl %>%
     tidyEmoji::emoji_extract_nest({{ tweet_text }}) %>%
@@ -44,7 +55,18 @@ emoji_extract_unnest <- function(tweet_tbl, tweet_text){
 #' @return The original dataframe/tibble with an extra column collumn called
 #' \code{.emoji_unicode}.
 #' @export
-#'
+#' @examples
+#' library(dplyr)
+#' data.frame(tweets = c("I love tidyverse \U0001f600\U0001f603\U0001f603",
+#'                       "R is my language! \U0001f601\U0001f606\U0001f605",
+#'                       "This Tweet does not have Emoji!",
+#'                       "Wearing a mask\U0001f637\U0001f637\U0001f637.",
+#'                       "Emoji does not appear in all Tweets",
+#'                       "A flag \U0001f600\U0001f3c1")) %>%
+#'          emoji_extract_nest(tweets)
+
+
+
 emoji_extract_nest <- function(tweet_tbl, tweet_text){
   tweet_tbl %>%
     dplyr::mutate(.emoji_unicode = stringr::str_extract_all({{ tweet_text }}, emoji::emojis %>%

R/emoji-summary.R

@@ -18,9 +18,19 @@
 #' @import stringr
 #' @import tibble
 #' @export
+#' @examples
+#' library(dplyr)
+#' data.frame(tweets = c("I love tidyverse \U0001f600\U0001f603\U0001f603",
+#'                       "R is my language! \U0001f601\U0001f606\U0001f605",
+#'                       "This Tweet does not have Emoji!",
+#'                       "Wearing a mask\U0001f637\U0001f637\U0001f637.",
+#'                       "Emoji does not appear in all Tweets",
+#'                       "A flag \U0001f600\U0001f3c1")) %>%
+#'          emoji_summary(tweets)
 #'
 
 
+
 emoji_summary <- function(tweet_tbl, tweet_text){
 
   num_tweets <- dim(tweet_tbl)[1]
@@ -53,6 +63,17 @@ emoji_summary <- function(tweet_tbl, tweet_text){
 #'
 #' @return A dataframe/tibble containing only text with at least one Emoji
 #' @export
+#' @examples
+#' library(dplyr)
+#' data.frame(tweets = c("I love tidyverse \U0001f600\U0001f603\U0001f603",
+#'                       "R is my language! \U0001f601\U0001f606\U0001f605",
+#'                       "This Tweet does not have Emoji!",
+#'                       "Wearing a mask\U0001f637\U0001f637\U0001f637.",
+#'                       "Emoji does not appear in all Tweets",
+#'                       "A flag \U0001f600\U0001f3c1")) %>%
+#'          emoji_tweets(tweets)
+#'
+
 
 emoji_tweets <- function(tweet_tbl, tweet_text){
 

R/top-n-emojis.R

@@ -19,7 +19,15 @@
 #' @import purrr
 #' @import dplyr
 #' @export
-#'
+#' @examples
+#' library(dplyr)
+#' data.frame(tweets = c("I love tidyverse \U0001f600\U0001f603\U0001f603",
+#'                       "R is my language! \U0001f601\U0001f606\U0001f605",
+#'                       "This Tweet does not have Emoji!",
+#'                       "Wearing a mask\U0001f637\U0001f637\U0001f637.",
+#'                       "Emoji does not appear in all Tweets",
+#'                       "A flag \U0001f600\U0001f3c1")) %>%
+#'          top_n_emojis(tweets, n = 2)
 
 
 top_n_emojis <- function(tweet_tbl, tweet_text, n = 20, duplicated_unicode = "no"){