Index of /web/packages/SC2API/readme

[ICO]NameLast modifiedSizeDescription
[PARENTDIR]Parent Directory  -  
[TXT]README.html2020-09-25 15:20 7.2K 
README

SC2API

Lifecycle: experimental Travis build status

The goal of SC2API is to build a simple and easy-to-use API wrapper for Blizzard Starcraft II API in the R programming language.

Installation

You can install the development version of SC2API from GitHub with:

# install.packages("devtools")
devtools::install_github("SamMorrissette/sc2api")

Note that there is also a vignette that comes with the package that can be installed using:

# install.packages("devtools")
devtools::install_github("SamMorrissette/sc2api", build_vignettes = TRUE, dependencies = TRUE)

Example Usage

This is a basic example to obtain the MMR (match-maker rating) of the current top 10 players in the North America Grandmaster leaderboard.

First, you must set your own token in the R environment by supplying your own client ID and client secret. For more information on how to obtain these, visit Getting Started.

library(SC2API)
set_token("YOUR CLIENT ID", "YOUR CLIENT SECRET")
data <- get_gm_leaderboard(1) # An argument of "1" corresponds to the North American ladder.
top10 <- data[1:10,] # Extract the top 10 players
playerMMR <- top10$mmr # Extract the "mmr" vector from each player. 
print(playerMMR)
#>  [1] 6609 6425 6338 6310 6293 6284 6228 6208 6157 6135