rules: Read account rules

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

Description

Returns a tibble of all the rules for an account. Rules are applied to mentions as they are received by BrandsEye.

Usage

rules(x, .show.progress)

## S3 method for class 'brandseyer2.account'
rules(x, .show.progress = interactive())

## S3 method for class 'list'
rules(x, .show.progress = interactive())

## S3 method for class 'data.frame'
rules(x, .show.progress = interactive())

## S3 method for class 'character'
rules(x, .show.progress = interactive())

Arguments

x	An object to read logs from.
.show.progress	A logical indicating whether to show a progress bar or not. By default, this only shows a progress bar in interactive environments. Also, progress bars will only be shown if 5 or more accounts are being examined.

Details

Rules can be read from various different kinds of object. An account() object is the most basic, although rules can also be read from a list of account objects (in which case the returned tibble will include an account code column), or from a tibble containing an account code column, such as that returned by account_list().

Value

A tibble of rule information,.

Methods (by class)

• brandseyer2.account: For an account() object.

• list: For a list of account objects.

• data.frame: For a data.frame that contains an account column of account codes.

• character: For a character vector

Examples

## Not run: 
account("TEST01AA") %>%
  rules()

# Expand the macro section of the tibble to easily
# see how rules effect mentions
account("TEST01AA") %>%
  rules() %>%
  tidyr::unnest_legacy()

## End(Not run)
## Not run: 
account("TEST01AA", "TEST02AA") %>%
  rules()

## End(Not run)
## Not run: 
account_list() %>%
  rules()

## End(Not run)

## Not run: 
rules("TEST01AA")
rules(c("TEST01AA", "TEST02AA"))

## End(Not run)

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