Compiled revision to rsketball based on reviewers' feedback #53
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Functions revision:
nba_scraper
:Edited docstring documentation for grammar (1st sentence) and spelling correction [as per @scao1].
Also included weblink to vignette for usage in docstring.
nba_boxplot
:Edited docstring documentation for grammar correction (1st sentence) [as per @scao1]
Also included weblink to vignette and dataset description for usage in docstring.
Function improved with warning functionality to warn user if
grouping_list
argument has elements that do not exist in the data set. Warning statement to show that misspecified elements will be removed. [as per @scao1 and @aakanksha023 ]Edited boxplot title to be more explicitly descriptive [as per @scao1]
nba_ranking
:Edited docstring documentation to include weblink to vignette and dataset description for usage.
Edited ranking visualization title to be more explicitly descriptive [as per @scao1]
Edited text font in visualization to default size as they were too large for a larger number of specified rankings (ie top = 5) [as per @aakanksha023 ]
nba_team_stats
:Edited docstring documentation to include weblink to vignette and dataset description for usage.
Function improved with warning functionality to warn user if
stats_filter
,teams_filter
,positions_filter
argument has elements that do not exist in the data set. Warning statement to show that misspecified elements will be removed. [as per @scao1 and @aakanksha023 ]General Documentation revision:
nba_scraper
to improve user onboarding experience when they are new to the package and have difficulty figuring out the other functions [as per @scao1]nba_boxplot
in Readme as a comparison of statistics among teams and position groupings. [as per @scao1 and @aakanksha023 ]nba_boxplot
(backtick formatting required for columns with "%" character).Feedback issues not covered in this PR (to be considered in other PR):
nba_ranking
[as per @aakanksha023 ]Also, there is no major feedback required for improvement/followup based on TA milestone 3 (after clarification). See closed issue #52.