R/mention_brands.R

Defines functions brands.data.frame

Documented in brands.data.frame

# 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 brands
#'
#' Fetch brand information from a tibble of mention data.
#'
#' @param ac An optional account object from which to take brand information.
#'
#' @export
#'
#' @examples
#'
#' # Finding the brands and sub-brands that mentions matched.
#' account("TEST01AA") %>%
#'   mentions("published inthelast week") %>%
#'   brands()
#'
brands.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% "brands", msg = "data.frame has no brands column")

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

  # For devtool::check
  parent <- NULL; name <- NULL; deleted <- NULL;

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

  ts
}
brandseye/brandseyer2 documentation built on Sept. 5, 2021, 2:15 p.m.