getTeamRoster: Get Team Roster

Description Usage Arguments Value Examples

Description

Returns the team roster, configurable for season. Convenience wrapper around getTeam(team = team, modifier = team.roster, season = season).

Usage

1
getTeamRoster(team, season = NULL)

Arguments

team

The team roster to get. Required

season

Which season's roster to get. Optional, will get the current roster if not supplied.

Value

the API output of teams' rosters

Examples

1
2
3
4
5
#See the Carolina Hurricane's roster (ID = 12)
canes <- getTeamRoster(12)

#Get their roster a few years ago
canes_past <- getTeamRoster(12, season = 20152016)

pbulsink/nhlRapi documentation built on June 27, 2019, 6:35 p.m.