root_brands: Find root brands in an account

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

Description

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

Usage

root_brands(x, includeDeleted, includeArchived, short)

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

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

## S3 method for class '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.

Author(s)

Constance Neeser

See Also

brands() for returning all brands in an account.

Examples

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

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

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

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