Api internal functions

Description

Primitive Api wrapper functions are not exported since they only allow for one call at a time. Instead, an equivalent functions is exposed allowing multiple parameters, making it easier to retrieve data for users.

Arguments

Get competition ahead-behind standings

Description

Get competition ahead-behind standings

Usage

getCompetitionAheadBehind(season_code, round)

Arguments

Value

Returns a summary tibble of ahead-behind for chosen competition and round

Reference webpage: Ahead-behind standings

Examples

## Not run: 

getCompetitionAheadBehind(season_code = c("E2023", "E2022"), round = 1)


## End(Not run)

Get competition calendar standings

Description

Get competition calendar standings

Usage

getCompetitionCalendar(season_code, round)

Arguments

Value

Returns a summary tibble of calendar standings for chosen competitions and rounds

Reference webpage: Calendar standings

Examples

if(interactive()) {

getCompetitionCalendar(season_code = c("E2023", "E2022"), round = 1)

}

Competition metadata

Description

Retrieve values of arguments for specific data collection functions across all package.

Usage

getCompetitionHistory(competition_code)

getCompetitionRounds(season_code)

getCompetitionPhases(season_code)

getCompetitionTeams(season_code)

getCompetitionGames(season_code, round, phase_type = "All")

Arguments

Value

For each function, returns a tibble with information about history, rounds, phases, teams or games of chosen season and competition code.

Examples

## Not run: 

getCompetitionHistory(competition_code = c("E", "U")) |> head(5)

getCompetitionRounds(season_code = c("E2023", "E2022")) |> head(5)

getCompetitionPhases(season_code = c("E2023", "U2023")) |> head(5)

getCompetitionTeams(season_code = c("E2023", "U2023")) |> head(5)

getCompetitionGames(season_code = "E2023", round = 1:5) |> head(5)


## End(Not run)

Get competition margins standings

Description

Get competition margins standings

Usage

getCompetitionMargins(season_code, round)

Arguments

Value

Returns a summary tibble of standing margins for chosen competition and round

Reference webpage: Margins standings

Examples

## Not run: 

getCompetitionMargins(season_code = c("E2023", "E2022"), round = 1)


## End(Not run)

Get competition traditional standings

Description

Get competition traditional standings

Usage

getCompetitionStandings(season_code, round)

Arguments

Value

Returns a summary tibble of standings for chosen competitions and rounds

Reference webpage: Traditional standings

Examples

## Not run: 

getCompetitionStandings(season_code = c("E2023", "E2022"), round = 1)


## End(Not run)

Get competition streaks standings

Description

Get competition streaks standings

Usage

getCompetitionStreaks(season_code, round)

Arguments

Value

Returns a summary tibble of streaks for chosen competitions and rounds

Reference webpage: Streaks standings

Examples

## Not run: 

getCompetitionStreaks(season_code = c("E2023", "E2022"), round = 1)


## End(Not run)

Get game box-score

Description

Usage

getGameBoxScore(season_code, game_code)

Arguments

Value

Returns a list of elements for the chosen games and seasons

• Team. Name of the teams

• Coach. Name of the coaches

• EndOfQuarter. Team accumulated points by quarter

• ByQuarter. Team points for each quarter

• PlayerStats. Statistics for each player in the game

• TeamStats. Aggregated statistics for each team in the game

Glossary of columns:

Reference webpage: BoxScore

Examples

## Not run: 

getGameBoxScore(season_code = c("E2023", "U2023"), game_code = 1)


## End(Not run)

Get game evolution

Description

Usage

getGameEvolution(season_code, game_code)

Arguments

Value

Returns a list of two elements for the chosen games and seasons

• EvolutionSummary. Overall information about minimum and maximum difference of scores between teams

• Evolution. Minute by minute points of each team

Reference webpage: GraphicStats

Examples

## Not run: 

getGameEvolution(season_code = c("E2023", "U2023"), game_code = 1)


## End(Not run)

Game metadata

Description

Retrieve contextual information about games. Outputs may be required as arguments of other ⁠getGame*⁠ functions

Usage

getGameHeader(season_code, game_code)

getGamePlayers(season_code, game_code, team_code)

getGameRound(season_code, game_code)

Arguments

Value

For each function, returns a tibble with information about header, player or round of chosen season and game code.

Examples

## Not run: 

getGameHeader(season_code = c("E2023", "U2023"), game_code = 1)

getGamePlayers(season_code = c("E2023", "U2023"), team_code = "ASV", game_code = 1)

getGameRound(season_code = c("E2023", "U2023"), game_code = 1)


## End(Not run)

Get game play-by-play

Description

Usage

getGamePlayByPlay(season_code, game_code)

Arguments

Value

Returns a list of two elements for the chosen games and seasons

• PlayByPlaySummary. Overall information about the games, teams involved and status (live or not)

• PlayByPlay. Detailed information about the games, particularly NumberOfPlay and PlayType

Glossary of PlayType:

Reference webpage: PlayByPlay

Examples

## Not run: 

PlayByPlay = getGamePlayByPlay(season_code = c("E2023", "U2023"), game_code = 1)

PlayByPlay$PlayByPlaySummary |> head(5)

PlayByPlay$PlayByPlay |> head(5)


## End(Not run)

Get game points

Description

Usage

getGamePoints(season_code, game_code)

Arguments

Value

Returns scoring information of each player for the chosen games and seasons (subset of play-by-play data). In particular:

• NumberOfPlay. Reference id of the action (useful for join with results of getPlayByPlay)

• CoordX and CoordY. Spatial coordinates of the shot

• Zone. Area of the court of the shot

Reference webpage: PlayByPlay

Examples

## Not run: 

getGamePoints(season_code = c("E2023", "U2023"), game_code = 1)


## End(Not run)

Get player advanced statistics

Description

Usage

getPlayerAdvanced(
  season_code,
  statistic_mode = c("perGame", "perMinute", "accumulated")
)

Arguments

Value

Returns a summary tibble of advanced players statistics for chosen seasons.

Glossary of columns:

Reference webpage: Stats

Examples

## Not run: 

getPlayerAdvanced(season_code = "E2023", statistic_mode = "perGame")


## End(Not run)

Get player miscellaneous statistics

Description

Usage

getPlayerMisc(season_code)

Arguments

Value

Returns a summary tibble of miscellaneous players statistics for chosen seasons.

Glossary of columns:

Reference webpage: Stats

Examples

## Not run: 

getPlayerMisc(season_code = "E2023")


## End(Not run)

Get player points statistics

Description

Usage

getPlayerPoints(season_code)

Arguments

Value

Returns a summary tibble of points players statistics for chosen seasons.

Glossary of columns:

Reference webpage: Stats

Examples

## Not run: 

getPlayerPoints(season_code = "E2023")


## End(Not run)

Get player statistics

Description

Usage

getPlayerStats(
  season_code,
  statistic_mode = c("perGame", "perMinute", "accumulated")
)

Arguments

Value

Returns a summary tibble of players statistics for chosen seasons.

Glossary of columns:

Reference webpage: Stats

Examples

## Not run: 

getPlayerStats(season_code = "E2023", statistic_mode = "perGame")


## End(Not run)

Team metadata

Description

Retrieve contextual information about teams. Outputs may be required as arguments of other ⁠getTeam*⁠ or ⁠getPlayer*⁠ functions.

Usage

getTeam(season_code, team_code)

getTeamPeople(season_code, team_code)

getTeamGames(season_code, team_code)

Arguments

Value

For each function, returns a tibble with information about team, people or games of chosen season and team code.

Examples

## Not run: 

getTeam(team_code = "ASV", season_code = c("E2023", "E2022")) |> head(5)

getTeamPeople(team_code = "ASV", season_code = c("E2023", "E2022")) |> head(5)

getTeamGames(team_code = "ASV", season_code = c("E2023", "E2022")) |> head(5)


## End(Not run)

Get team lead statistics

Description

Usage

getTeamLeadStats(season_code, phase_type = "All", subset = "All")

Arguments

Value

Returns a list of elements for the chosen seasons, phase_type and subset.

• TeamAccumulated. Total sum of statistics of all teams team

• TeamAveragePerGame. Average per game of statistics of all teams

Glossary of columns:

Reference webpage: TeamLead

Examples

## Not run: 

  TeamLeadStats = getTeamLeadStats(season_code = c("E2022", "E2023"), phase_type = "RS")

  TeamLeadStats$TeamAccumulated |> head(5)

  TeamLeadStats$TeamAveragePerGame |> head(5)


## End(Not run)

Get team statistics

Description

Usage

getTeamStats(season_code, team_code, phase_type = "All")

Arguments

Value

Returns a list of elements for the chosen teams and seasons:

• PlayerAccumulated. Total sum of statistics by player

• PlayerAveragePerGame. Average per game of statistics by player

• PlayerAveragePer40. Average per 40 minutes of statistics by player

• TeamAccumulated. Total sum of statistics of team

• TeamAveragePerGame. Average per game of statistics of teams

Glossary of columns:

Reference webpage: Team

Examples

## Not run: 

  TeamStats = getTeamStats(team_code = "ASV", season_code = c("E2023", "E2022"), phase_type = "RS")

  TeamStats$PlayerAccumulated |> head(5)

  TeamStats$PlayerAveragePerGame |> head(5)

  TeamStats$PlayerAveragePer40 |> head(5)

  TeamStats$TeamAccumulated |> head(5)

  TeamStats$TeamAveragePerGame |> head(5)


## End(Not run)