R/mention_phrases.R

In brandseye/brandseyer2: Provides access to data stored in a BrandsEye account

# Copyright (c) 2018, Brandseye PTY (LTD)
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

#' @describeIn phrases
#'
#' Fetch phrase information from a tibble of mention data.
#'
#' @param ac An optional account object from which to take phrase information.
#'
#' @note [mentions()] should be called with `select = "phrases"`
#' to ensure that phrase information is returned with the mentions.
#'
#' @export
phrases.data.frame <- function(x, ..., ac = attr(x, "account")) {
  assert_that(x %has_name% "id", msg = "data.frame has no mention id column")
  assert_that(x %has_name% "phrases", msg = "data.frame has no `phrases` column. See the `select` argument of `mentions()`")

  ts <- x %>%
    select(id, phrases) %>%
    unnest_legacy(phrases = map(phrases, ~ .x %||% NA))

  # For devtool::check


  if (!is.null(ac)) {
    ts <- ts %>%
      left_join(ac %>% phrases(), by = c("phrases" = "phrase.id")) %>%
      rename(phrase.id = phrases)
  } else rlang::warn("No account information to use - see `ac` argument to `phrases()`")

  ts
}