Package 'fivbvis'

Title: Client for the FIVB VIS Web Service \url{https://www.fivb.org/VisSDK/VisWebService/}
Description: Client for the FIVB VIS web service.
Authors: Ben Raymond [aut, cre], Adrien Ickowicz [aut], Tyler Widdison [aut], openvolley.org [org]
Maintainer: Ben Raymond <[email protected]>
License: MIT + file LICENSE
Version: 0.0.6
Built: 2024-10-21 04:47:44 UTC
Source: https://github.com/openvolley/fivbvis

Help Index

fivbvis

Description

Client for the FIVB VIS web service

Get or set fivbvis caching behaviour

Description

By default, fivbvis starts with session-specific caching (equivalent to running ⁠v_caching(TRUE); v_cache_dir("session")⁠).

Usage

v_caching(caching)

v_cache_dir(cache_dir)

Arguments

caching

logical or string: if TRUE, used cached results; if FALSE, no caching; if "refresh", refresh the cache
cache_dir

string: either

  • "session" - use a session-specific directory for caching, meaning that when R is closed and restarted, the cache will be cleared and a new one used

  • "user" - use a persistent, user-specific directory (as returned by user_data_dir

  • or a string giving a path to a specific directory to use. The directory must already exist

Value

The caching setting (for v_caching) or cache directory (for v_cache_dir) after applying any provided parameters

Examples

v_caching(TRUE) ## turn caching on
v_caching(FALSE) ## turn caching off
v_caching("refresh") ## contents in cache will be updated

v_cache_dir() ## return current cache dir
## Not run: 
  v_cache_dir("session") ## use per-session cache
  v_cache_dir("user") ## use persistent, user-specific cache
  v_cache_dir("c:/my/cache/dir") ## use specific dir

## End(Not run)

Return the fields for a given VIS data type

Description

Return the fields for a given VIS data type

Usage

v_fields(type)

Arguments

type

string: the data type, currently one of "Volleyball Tournament", "Volleyball Tournament Ranking", "Volleyball Tournament Filter", "Volleyball Player", "Volleyball Match"

Value

A character vector of field names

References

https://www.fivb.org/VisSDK/VisWebService/

Examples

v_fields("Volleyball Tournament")

Retrieve a country flag image

Description

Retrieve a country flag image

Usage

v_flag(country_code)

Arguments

country_code

string: the ISO 3166-1 alpha-2 code of the country. For federations, you need to convert the federation code to the equivalent country code. If there is no equivalent country (for ENG, NIR, SCO, WAL), you can use the 3 letters federation code to retrieve the flag.

Value

Path to image file

References

https://www.fivb.org/VisSDK/VisWebService/#Country%20flags%20(small).html

Examples

## Not run: 
  v_flag("AU")

## End(Not run)

Get a beach volleyball match

Description

Get a beach volleyball match

Usage

v_get_beach_match(no, fields)

Arguments

no

integer: match number
fields

character: fields to return

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetBeachMatch.html

Examples

## Not run: 
  v_get_beach_match(15592)

## End(Not run)

Get a list of beach volleyball matches

Description

Get a list of beach volleyball matches

Usage

v_get_beach_match_list(fields = v_fields("Beach Match"), version, filter)

Arguments

fields

character: fields to return
version

integer: version of local list (currently ignored)
filter

list: (currently ignored)

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetBeachMatchList.html

Examples

## Not run: 
  v_get_beach_match_list()

## End(Not run)

Request to get a beach volleyball Olympic Selection ranking

Description

Request to get a beach volleyball Olympic Selection ranking

Usage

v_get_beach_olympic_selection_ranking(
  gender,
  gamesyear,
  onlyselected,
  referencedate,
  fields = v_fields("Beach Olympic Selection Ranking")
)

Arguments

gender

character: gender of the olympic ranking selection
gamesyear

integer: year to return ranking selection. if this parameter is not specified, the web service will return the ranking for the latest olympic games with a ranking.
onlyselected

logical: the selection status of the returned teams. If NULL or not specified, the resulting list will contain both selected and not-selected teams. If FALSE, the resulting list will contain only non-selected teams. If TRUE, the resulting list will contain only selected teams
referencedate

Date: reference date of the ranking: when the ranking has been calculated. If there is no Olympic Games selection ranking calculated at the specified date, the returned ranking will be empty. If this parameter is not specified, the web service will return the ranking for the latest reference date
fields

character: fields to return

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetBeachOlympicSelectionRanking.html

Examples

## Not run: 
  v_get_beach_olympic_selection_ranking("W")

## End(Not run)

Get a beach volleyball round

Description

Get a beach volleyball round

Usage

v_get_beach_round(no, fields)

Arguments

no

integer: round number
fields

character: fields to return

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetBeachRound.html

Examples

## Not run: 
  v_get_beach_round(3054)

## End(Not run)

Get a list of beach volleyball rounds

Description

Get a list of beach volleyball rounds

Usage

v_get_beach_round_list(fields = v_fields("Beach Round"), version, filter)

Arguments

fields

character: fields to return
version

integer: version of local list (currently ignored)
filter

list: (currently ignored)

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetBeachRoundList.html

Examples

## Not run: 
  v_get_beach_round_list()

## End(Not run)

Request to get the ranking of a beach volleyball round

Description

Request to get the ranking of a beach volleyball round

Usage

v_get_beach_round_ranking(no, fields = v_fields("Beach Round Ranking"))

Arguments

no

integer: number of the beach volleyball round
fields

character: fields to return

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetBeachRoundRanking.html

Examples

## Not run: 
  v_get_beach_round_ranking(980)

## End(Not run)

Get a beach volleyball team

Description

Get a beach volleyball team

Usage

v_get_beach_team(no, fields)

Arguments

no

integer: team number
fields

character: fields to return

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetBeachTeam.html

Examples

## Not run: 
  v_get_beach_team(375442)

## End(Not run)

Get a list of beach volleyball teams

Description

Get a list of beach volleyball teams

Usage

v_get_beach_team_list(fields = v_fields("Beach Team"), version, filter)

Arguments

fields

character: fields to return
version

integer: version of local list (currently ignored)
filter

list: (currently ignored)

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetBeachTeamList.html

Examples

## Not run: 
  v_get_beach_team_list()

## End(Not run)

Get a beach tournament

Description

Get a beach tournament

Usage

v_get_beach_tournament(no, fields)

Arguments

no

integer: the number of the tournament
fields

character: fields to return

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetBeachTournament.html

Examples

## Not run: 
  v_get_beach_tournament(502)

## End(Not run)

Get a list of beach tournaments

Description

Get a list of beach tournaments

Usage

v_get_beach_tournament_list(
  fields = v_fields("Beach Tournament"),
  version,
  filter
)

Arguments

fields

character: fields to return
version

integer: version of local list (currently ignored)
filter

list: (currently ignored)

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetBeachTournament.html

Examples

## Not run: 
  v_get_beach_tournament_list()

## End(Not run)

Request to get the ranking of a beach volleyball tournament

Description

Request to get the ranking of a beach volleyball tournament

Usage

v_get_beach_tournament_ranking(
  no,
  phase,
  fields = v_fields("Beach Tournament Ranking")
)

Arguments

no

integer: number of the beach volleyball tournament
phase

string: phase for which to return the ranking ("Qualification" or "MainDraw")
fields

character: fields to return

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetBeachTournamentRanking.html

Examples

## Not run: 
  v_get_beach_tournament_ranking(503)

## End(Not run)

Request to get a beach volleyball World Tour ranking

Description

Request to get a beach volleyball World Tour ranking

Usage

v_get_beach_world_tour_ranking(
  gender,
  number,
  referencedate,
  fields = v_fields("Beach World Tour Ranking")
)

Arguments

gender

character: gender of the teams to retrieve the ranking for
number

integer: number of entries to return
referencedate

date: reference date of the ranking when the ranking has been calculated. YYY-MM-DD. if there is no World Tour ranking calculated at the specified date, the returned ranking will be empty. if this parameter is not specified, the web service will return the ranking for the latest reference date.
fields

character: fields to return

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetBeachWorldTourRanking.html

Examples

## Not run: 
  v_get_beach_world_tour_ranking("W")

## End(Not run)

Get an event

Description

Get an event

Usage

v_get_event(no, fields)

Arguments

no

integer: the number of event
fields

character: fields to return

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetEvent.html

Examples

## Not run: 
  v_get_event(1)

## End(Not run)

Get an event list

Description

Get an event list

Usage

v_get_event_list(fields = v_fields("Event"), version, filter)

Arguments

fields

character: fields to return
version

integer: version of local list (currently ignored)
filter

list: (currently ignored)

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetEventList.html

Examples

## Not run: 
  v_get_event_list()

## End(Not run)

Get a player

Description

Get a player

Usage

v_get_player(no, fields)

Arguments

no

integer: the number of the player
fields

character: fields to return

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetPlayer.html

Examples

## Not run: 
  v_get_player(100002)

## End(Not run)

Get a list of press releases

Description

Get a list of press releases

Usage

v_get_press_release_list(
  no,
  startindex = 1,
  filter,
  fields = v_fields("Press Release")
)

Arguments

no

integer: the number of press releases to return
startindex

integer: index of the first press release to return
filter

list: (currently ignored)
fields

character: fields to return

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetPressReleaseList.html

Examples

## Not run: 
  v_get_press_release_list(10)

## End(Not run)

Get a press release text

Description

Get a press release text

Usage

v_get_press_release_text(no, language, fields = v_fields("Press Release Text"))

Arguments

no

integer: press release number
language

string: (currently ignored)
fields

character: fields to return

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetPressReleaseText.html

Examples

## Not run: 
  v_get_press_release_text(28639)

## End(Not run)

Get a list of referees

Description

Get a list of referees

Usage

v_get_referee_list(fields = v_fields("Referee"), version, filter)

Arguments

fields

character: fields to return
version

integer: version of local list (currently ignored)
filter

list: (currently ignored)

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#Beach%20Live_xsd~e-BeachLive~e-Referee.html

Examples

## Not run: 
  v_get_referee_list()

## End(Not run)

Get a volleyball match

Description

Get a volleyball match

Usage

v_get_volley_match(no, fields)

Arguments

no

integer: match number
fields

character: fields to return

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetVolleyMatch.html

Examples

## Not run: 
  v_get_volley_match(7604)

## End(Not run)

Get a list of volleyball matches

Description

Get a list of volleyball matches

Usage

v_get_volley_match_list(fields = v_fields("Volleyball Match"), version, filter)

Arguments

fields

character: fields to return
version

integer: version of local list (currently ignored)
filter

list: (currently ignored)

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetVolleyMatchList.html

Examples

## Not run: 
  v_get_volley_match_list()

## End(Not run)

Get a registration of a player in a volleyball tournament

Description

Get a registration of a player in a volleyball tournament

Usage

v_get_volley_player(no, fields)

Arguments

no

integer: the number of the player registration
fields

character: fields to return

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetVolleyPlayer.html

Examples

## Not run: 
  v_get_volley_player(2508)

## End(Not run)

Get a list of registration of players in volleyball tournaments

Description

Get a list of registration of players in volleyball tournaments

Usage

v_get_volley_player_list(
  fields = c(v_fields("Volleyball Player"), "FirstName", "LastName"),
  version,
  filter
)

Arguments

fields

character: fields to return
version

integer: version of local list (currently ignored)
filter

list: (currently ignored)

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetVolleyPlayerList.html

Examples

## Not run: 
  v_get_volley_player_list()

## End(Not run)

Get a volleyball tournament

Description

Get a volleyball tournament

Usage

v_get_volley_tournament(no, fields)

Arguments

no

integer: the tournament number ("No" as returned by v_get_volley_tournament_list
fields

character: fields to return

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetVolleyTournament.html

Examples

## Not run: 
  v_get_volley_tournament(1)

## End(Not run)

Get a list of volleyball tournaments

Description

Get a list of volleyball tournaments

Usage

v_get_volley_tournament_list(
  fields = v_fields("Volleyball Tournament"),
  version,
  filter
)

Arguments

fields

character: fields to return
version

integer: version of local list (currently ignored)
filter

list: (currently ignored)

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetVolleyTournamentList.html

Examples

## Not run: 
  v_get_volley_tournament_list()

## End(Not run)

Get the ranking of a volleyball tournament

Description

Get the ranking of a volleyball tournament

Usage

v_get_volley_tournament_ranking(
  notournament,
  fields = v_fields("Volleyball Tournament Ranking")
)

Arguments

notournament

integer: the tournament number ("No" as returned by v_get_volley_tournament_list
fields

character: fields to return

Value

A data.frame

References

https://www.fivb.org/VisSDK/VisWebService/#GetVolleyTournamentRanking.html

Examples

## Not run: 
  v_get_volley_tournament_ranking(1032)

## End(Not run)

Set or get fivbvis options

Description

Set or get fivbvis options

Usage

v_options(huge_xml = FALSE, verbose = FALSE)

Arguments

huge_xml

logical: if TRUE, set the XML parsing options to allow "huge" (i.e. deeply-nested) XML documents to be parsed
verbose

logical: if TRUE, display progress information

Value

The current options (invisibly unless at least one parameter has been provided)