Find root brands in an account

Source: R/account_root_brands.R

Root brands are the brands around which we collect mentions, and determine sentiment. Sentiment is always towards the brand.

root_brands(x, includeDeleted, includeArchived, short)

# S3 method for data.frame
root_brands(x, includeDeleted = FALSE, includeArchived = FALSE, short = TRUE)

# S3 method for brandseyer2.account
root_brands(x, includeDeleted = FALSE, includeArchived = FALSE, short = TRUE)

# S3 method for list
root_brands(x, includeDeleted = FALSE, includeArchived = FALSE, short = TRUE)

Arguments

x

The object to find root brands for.
includeDeleted

Whether to include deleted root brands. By default, only shows non-deleted brands.
includeArchived

Whether to include archived root brands. By default, only shows non-archived brands.
short

Include only the most import bits of brand information, such as the name and ID.

Value

A tibble containing rows only for the root brands of an account. Otherwise, like the table returned in brands().

Methods (by class)

  • data.frame: Find root brands from a tibble or data.frame. The data.frame should have id, parent, and deleted columns, just as the tibble returned from brands() does.

  • brandseyer2.account: Returns root brand information from an account object.

  • list: Returns root brand information from a list of account objects.

See also

brands() for returning all brands in an account.

Author

Constance Neeser

Examples


# Get root brands for an account
account("TEST01AA") %>%
  root_brands()

#> # A tibble: 2 x 4
#>      id name            deleted archived
#>   <int> <chr>           <lgl>      <dbl>
#> 1     1 Your Brand Here FALSE         NA
#> 2     2 Sibling Brand   FALSE         NA

# Get root brands from a tibble or data.frame
account(c("TEST01AA", "TEST02AA")) %>%
  brands(short = FALSE) %>%
  root_brands()

#> Joining, by = "id"
#> # A tibble: 3 x 5
#>   account     id name               deleted archived
#>   <chr>    <dbl> <chr>              <lgl>      <dbl>
#> 1 TEST01AA     2 Sibling Brand      FALSE         NA
#> 2 TEST02AA   100 The Best of Brands FALSE         NA
#> 3 TEST01AA     1 Your Brand Here    FALSE         NA

# Show fuller root brand information
account("TEST01AA") %>%
  root_brands(short = FALSE)

#> # A tibble: 2 x 14
#>      id parent name     description tier    deleted schema filter   volume_limit
#>   <int>  <int> <chr>    <lgl>       <chr>   <lgl>   <chr>  <chr>           <int>
#> 1     2     NA Sibling… NA          TOPICS  FALSE   b0000… locatio…           NA
#> 2     1     NA Your Br… NA          ESSENT… FALSE   NA     NA                 NA
#> # … with 5 more variables: topic_tree_id <dbl>, sentiment_rate <dbl>,
#> #   topic_rate <dbl>, archived <dbl>, phrases <list>