R/steamR-package.R

In josegallegos07/steamR: An interface to Steam's Web API

#' An interface to Steam's Web API.
#'
#' This package provides a wrapper for Steam's Web API.
#'
#' @docType package
#' @name steamR
#' @title steamR
#' @author Jose Gallegos, \email{josegallegos07@@gmail.com}
#'
#' @section Methods:
#' See \code{\link{steamR_methods}} for a list of methods available in the steamR package.
#'
#' @section Steam Web API Key:
#' All use of the Steam Web API requires the use of an API Key.
#'
#' Get a Steam Web API Key at \url{http://steamcommunity.com/dev/apikey}.
#'
#' @section Steam API Terms of Use:
#' Use of Steam's APIs requires that you agree to the \href{http://steamcommunity.com/dev/apiterms}{Steam API Terms of Use}.
#'
#' @section Steam Web API Documentation:
#' Documentation for Steam's Web API can be found \href{https://developer.valvesoftware.com/wiki/Steam_Web_API}{here}.
NULL

#' Methods
#'
#' Returns a list of available steamR methods. 
#'
#' @export
#' @return A list of methods available in the steamR package.

steamR_methods <- function ()
{
  lsf.str("package:steamR")
}