Skip to content

Compiled revision to rsketball based on reviewers' feedback #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 23, 2020

Conversation

kfoofw
Copy link
Collaborator

@kfoofw kfoofw commented Mar 22, 2020

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:

  • Relocating the dataset description file to near the beginning of the subsection "Usage Examples" after 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]
  • Updated description for nba_boxplot in Readme as a comparison of statistics among teams and position groupings. [as per @scao1 and @aakanksha023 ]
  • Minor edits on vignette.rmd file due to some error in the "important statement" for the example of nba_boxplot (backtick formatting required for columns with "%" character).

Feedback issues not covered in this PR (to be considered in other PR):

  • Listing of dependencies in Readme documentation [as per @scao1 and @aakanksha023 ]
  • Additional Github Actions build test for R > 3.6 with respect to ubuntu-16.04 [as per @aakanksha023 ]
  • Colour scheme changes for nba_ranking [as per @aakanksha023 ]
  • Consistent error messages across different functions [as per @aakanksha023 ]
  • Suggestion on reduction of examples in vignette to reduce documentation length [as per @aakanksha023].

Also, there is no major feedback required for improvement/followup based on TA milestone 3 (after clarification). See closed issue #52.

@codecov
Copy link

codecov bot commented Mar 22, 2020

Codecov Report

Merging #53 into master will not change coverage by %.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff            @@
##            master       #53   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         4           
  Lines          186       207   +21     
=========================================
+ Hits           186       207   +21     
Impacted Files Coverage Δ
R/nba_scraper.R 100.00% <ø> (ø)
R/nba_boxplot.R 100.00% <100.00%> (ø)
R/nba_ranking.R 100.00% <100.00%> (ø)
R/nba_team_stats.R 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a85eee0...831b75e. Read the comment docs.

@vanandsh vanandsh self-requested a review March 22, 2020 17:07
@vanandsh vanandsh added this to the final milestone milestone Mar 22, 2020
Copy link
Collaborator

@vanandsh vanandsh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Kenneth! I see all issues have been addressed.

@AndresPitta AndresPitta self-requested a review March 23, 2020 00:21
@AndresPitta AndresPitta merged commit 302508a into master Mar 23, 2020
@AndresPitta
Copy link
Collaborator

Nice Job, Thanks @kfoofw

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants