brew_analytics_events: Retrieve Analytics Events for Homebrew Formulae for a Given...

Description Usage Arguments Details Value Note References Examples

Description

Get analytics event data such as event count, percent and time range.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
brew_analytics_events(category = c("install", "install-on-request",
  "cask-install", "build-error", "os-version"), delta = c(30, 90, 365))

brew_install_events(delta = c(30, 90, 365))

brew_install_on_request_events(delta = c(30, 90, 365))

brew_build_error_events(delta = c(30, 90, 365))

brew_cask_install_events(delta = c(30, 90, 365))

brew_os_version_events(delta = c(30, 90, 365))

Arguments

category

the category of the analytics events (the default is install events. The following are acceptable inputs:

  • install: the installation of all formulae

  • install-on-request: the requested installation of all formulae (i.e. not as a dependency of other formulae)

  • cask-install: the installation of all casks

  • build-error: the installation failure of all formulae

  • os-version: the macOS version of the machine that submitted an event

delta

number of previous days to return. One of 30, 90, 365

Details

The old Homebrew Analytics API had different endpoints for analytics event metrics. These have been kept as wrappers to the new function and other conveneince functions have been added. Thse are:

Value

data frame (tibble)

Note

The results of the API call are memoised as they won't likely won't change between calls in the same R session. Use the facilities provided by the memoise package to clear the cache if you use this in a long running R session.

References

https://formulae.brew.sh/docs/api/

Examples

1
xdf <- brew_analytics_events("install", 30)

hrbrmstr/homebrewanalytics documentation built on May 7, 2019, 7:41 a.m.