search

UBC-MDS / rpuck

An API Client R Package
https://ubc-mds.github.io/rpuck/
Other
1 stars 0 forks source link

Seasonal Attendance Function #5

Closed jnederlo closed 4 years ago

jnederlo commented 4 years ago

This function will make a query to the Attendance API to get the NHL's seasonal and playoff attendance numbers. These number go from the 1975-76 season to the 2018- 19 season.

The main purpose of this function will be to display the NHL seasonal attendance numbers in a ggplot chart. The chart to display will depend on how much data is returned.

This is the source: attendance.

The function should take in 3 arguments: playoffs, regular, season

The playoffs and regular arguments are of type boolean and the season argument is of type string.

The user must select one of playoffs and/or regular. They can either send in a season, or leave it blank. If they leave it blank all seasonal data will be displayed.

For example: rpuck.attendance(regular=True, playoffs=True, season=None)

A call like this would return all of the data from the API. The function would then parse it and display it in an appropriate chart (for example a grouped bar chart showing the attendance by year).

To Do for Milestone 1:

jnederlo commented 4 years ago

This Issue is closed with PR #8