nhlapi (version 0.1.4)

nhl_players: Retrieve metadata for players based on names or ids

Description

Retrieves information on players from the NHL API based on playerNames or playerIds. If playerNames are provided, they take precedence over playerIds.

Usage

nhl_players(playerNames, playerIds = NULL)

Arguments

playerNames

character(), vector of one or more player names. Not case sensitive for convenience.

playerIds

integer(), vector of one or more ids of the players. The ids correspond to the ids expected by the NHL API people endpoint. For most cases the playerNames argument can be provided for more convenient usage.

Value

data.frame, with information on selected players.

Examples

# NOT RUN {
 # With player names
 nhl_players(c("joe SAKIC", "patrick roy"))

 # With playerIds
 nhl_players(playerIds = c(8451101, 8458554))
# }