metrics: See metrics in a dashboard

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

Description

This provides easy access to metric information stored in the metric column of a tibble returned by sections() and dashboards(). It essentially uses tidyr::unnest_legacy() to clean up the table.

Usage

metrics(x, m, ...)

## S3 method for class 'data.frame'
metrics(x, m, collapse = TRUE, ...)

Arguments

x	The tibble to pull widget information from.
m	An optional filter for selecting metrics. A numeric vector allows you to choose metrics with the given IDs. A character vector allows you to choose metrics with matching captions.
...	Parameters for other methods.
collapse	A logical value indicating whether columns should be removed (collapsed) or not.

Details

This provides an additional field not available in the original metric information called filter. This indicates the filter that the metric would have used to call information from the BrandsEye API, and is a combination of the section and metric filters.

Value

An unnested table of metrics.

Methods (by class)

• data.frame: Expand metric information for data frames.

See Also

dashboards() to pull dashboard information for an account.

sections() to pull section information for an account.

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