R/mentions.R

In mkearney/rtweet: Collecting Twitter Data

#' Get mentions for the authenticating user.
#'
#' Returns data on up to 200 of the most recent mentions (Tweets
#' containing a users's screen_name) of the authenticating user.
#' The timeline returned is the equivalent of the one seen when you view 
#' your mentions on twitter.com.
#'
#' @inheritParams TWIT_paginate_max_id
#' @param ... Other arguments passed as parameters in composed API
#'   query.
#' @return Tibble of mentions data.
#' @family tweets
#' @examples
#'
#' \dontrun{
#' tw <- get_mentions()
#' tw
#' 
#' # newer mentions
#' get_mentions(since_id = tw)
#' }
#' @references <https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-mentions_timeline>
#' @export
get_mentions <- function(n = 200,
                         since_id = NULL,
                         max_id = NULL,
                         parse = TRUE,
                         retryonratelimit = NULL,
                         verbose = TRUE,
                         token = NULL,
                         ...) {

  params <- list(...)
  r <- TWIT_paginate_max_id(token, "/1.1/statuses/mentions_timeline", params,
    n = n,
    since_id = since_id,
    max_id = max_id,
    retryonratelimit = retryonratelimit,
    verbose = verbose
  )
  
  if (parse) {
    r <- lapply(r, parse_mentions)
    r <- do.call("rbind", r)
    r$created_at <- format_date(r$created_at)
  }
  r
}

parse_mentions <- function(x) {
  out <- tibble::as_tibble(wrangle_into_clean_data(x, "status"))
  if (has_name_(x, "user")) {
    users <- tibble::as_tibble(wrangle_into_clean_data(x, "user"))
    attr(out, "users") <- users
  }
  out
}