bggAnalytics (version 0.2.1)

bggSearch: API for BoardGameGeek search engine

Description

Search for items on the BoardGameGeek with a given query. See bggAPI for more details on inherited slots and methods.

Super class

bggAnalytics::bggAPI -> bggSearch

Active bindings

query

A single string with the wanted query.

Methods

Public methods

• bggSearch$new()

• bggSearch$print()

• bggSearch$clone()

Inherited methods

• bggAnalytics::bggAPI$expand()
• bggAnalytics::bggAPI$fetch()
• bggAnalytics::bggAPI$switch_namestyle()

---

Method new()

Object initialization.

Usage

bggSearch$new(query, params = NULL)

Arguments

query

a single string, query used to perform the search.

params

a list of object parameters. If not all the parameters are included in the list, default values are used (NULL instead of the list is possible for all the default parameters).
Following parameters are allowed for the bggGames class with default values in parentheses:

• pretty_names - (FALSE) a boolean value, should the object should use pretty names,

• type - (NULL) a single string, type of things to look for. Possible values: 'rpgitem', 'videogame', 'boardgame', 'boardgameaccessory', 'boardgameexpansion'. NULL uses all possible values.

• exact - (FALSE) a boolean value, should the results be restricted to items that match the query exactly.

---

Method print()

Print object information.

Usage

bggSearch$print()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

bggSearch$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Details

Note that the result is trimmed to items with unique IDs. Due to XML API2 `Search` returning multiple items for a single ID with different types, variable 'type' might be not accurately represented.

References

BoardGameGeek XML API2