R package for simple downloading and organisation of board game data using BoardGameGeek's XML API2. Users of R programming language should have no problems extracting their BGG games collection data, or in fact, the information about any games from BGG. This allows for automatisation of the collection exporting task, which has to be done manually on the BGG website.
The package will be uploaded to CRAN in the future. In the meanwhile, it can be installed using the
The package uses R6 classes and
data.table package as a backbone for data. Hence usage is heavily leaning on reference, which is quite uncommon for R programming language.
Easiest way to start is to create a bggCollection object for a certain user. For showcase purposes, I'm using my BGG account called
library(bggAnalytics) my_collection <- bggCollection$new(username = "Beo_") my_collection
Another step would be to fetch some data - everything (from the set of currently supported variables) can be fetched using
my_collection$fetch() # Or my_collection$fetch(c("name", "yearpublished"))
extend can be used in the same manner to extend object's
data slot by given variables.
my_collection$data # Currently only objectid my_collection$extend(c("name", "yearpublished")) my_collection$data
Note that this extension is done by reference, hence no assignment is necessary.
One doesn't have to rely on a given user's collection to download game's data. You can find a game ID by looking at it's BGG hyperlink, e.g. https://boardgamegeek.com/boardgame/167791/terraforming-mars is a link for Terraforming Mars, hence 167791 is it's ID.
games <- bggGames$new(ids = 167791) games$extend() games$data
Naturally, multiple IDs may be supplied to
bggGames object. One can always extract IDs from a collection by
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.