R/biorxiv_usage.R

In rbiorxiv: Client for the 'bioRxiv' API

#' Retrieve summary statistics for usage of bioRxiv content
#'
#' @export
#'@param interval (character) Return either monthly `m` or yearly `y` data.
#' Default: `m`
#' @param format (character) Return data in list `list`, json `json` or data
#' frame `df` format. Default: `list`
#'
#' @examples \donttest{
#'
#' # Return a list of monthly usage statistics
#' biorxiv_usage(interval = "m")
#'
#' # Return data in a data frame
#' biorxiv_usage(interval = "m", format = "df")
#'
#' # Return annual usage statistics
#' biorxiv_usage(interval = "y")
#' }
biorxiv_usage <- function(interval = "m", format = "list") {

  # Check internet connection is available
  check_internet_connection()

  # Validate individual arguments
  validate_args(interval = interval, format = format)

  # Generate URL for query
  url <- paste0(base_url(), "/usage/", interval)

  # Make query
  content <- do_query(url = url)

  # Extract data
  data <- content$`bioRxiv content statistics`

  # Return data in requested format
  return_data(data = data, format = format)
}