R/brandseyer2.R

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

#' brandseyer2: access and perform analytics on your BrandsEye accounts
#'
#' BrandsEye is a company that provides online monitoring, analytics,
#' and insights for social media data. We provide an extensive JSON / RESTful API
#' to access your data. This library is a wrapper for that data, providing
#' easy access to the data in your various BrandsEye accounts for use in
#' any R analyses and data visualisations.
#'
#' @section Starting points:
#'
#' To ease your use of the library, you should begin by adding your API key using
#' the authenticate function:
#'
#' \verb{
#' authenticate("<your api key>", save = TRUE)
#' }
#'
#' Contact your client service provider to get your api key. If you would
#' like to know more, see the documentation for [authenticate()].
#'
#' After this, you can easily see a list of your available accounts using
#' [list_account_codes()]. [account_count()] will
#' let you pull aggregate information matching a given filter from one or more
#' of your accounts.
#'
#' @seealso [list_account_codes()] Find out what accounts you have access to.
#' @seealso [account_count()] Query your account.
#' @seealso [account()] Find out about general account queries.
#' 
#' @docType package
#' @name brandseyer2
#' @aliases brandseye BrandsEye BrandsEyeR2
#' NULL