Peer Review Feedback

[rbouwer]

Tests

• check test framework - potential compatibility issues with non-Mac users (https://github.com/UBC-MDS/software-review-2024/issues/9#issuecomment-1915907137 - 1)Tests passed for Joey (https://github.com/UBC-MDS/software-review-2024/issues/9#issuecomment-1916139577)
  • Look into Marco's experience with Windows: (https://github.com/UBC-MDS/software-review-2024/issues/9#issuecomment-1917919802 - 3, 4) @phchen5

Flies to Delete

• remove pyxplor.py (https://github.com/UBC-MDS/software-review-2024/issues/9#issuecomment-1915907137 - 2) (https://github.com/UBC-MDS/software-review-2024/issues/9#issuecomment-1916139577 - 1) (https://github.com/UBC-MDS/software-review-2024/issues/9#issuecomment-1916277295 - 2) (https://github.com/UBC-MDS/software-review-2024/issues/9#issuecomment-1917919802 - 1) @iris0614 (DELETE: pyxplor.py from src AND from tests)

Vignette @rbouwer

• Break the Main Vignette, into smaller ones, could have a quick look, basic usage section. A longer in depth vignette going into the lengthy explorations that are possible with the package (separated) under a separate tab. Albeit the current breakdown is definitely helpful. (https://github.com/UBC-MDS/software-review-2024/issues/9#issuecomment-1915907137 - 3)
• It would be better if there was more context about the dataset, and a more detailed introduction explaining the importance and applications of EDA in data science would help users understand the relevance and application of the examples. (https://github.com/UBC-MDS/software-review-2024/issues/9#issuecomment-1916139577 - 2)
• If possible, include interactive elements or widgets in the tutorial for a hands-on experience. These interactive elements can make the learning process more engaging and effective, and help users better understand the capabilities and use of the package. (https://github.com/UBC-MDS/software-review-2024/issues/9#issuecomment-1916139577 - 3)

Function Improvements

• plot_categorical @rbouwer (Nice to have - OPTIONAL)
  • For the categorical bar plots, they could be ordered by largest to smallest to make it easier to visualise the categories. They are ordered in the facetted plots, only the first plot in the docs for categorical is not. (https://github.com/UBC-MDS/software-review-2024/issues/9#issuecomment-1915907137 - 4)
  • It might be beneficial to reconsider the use of colour in the Distribution of Categorical Variables. The current approach assigns colours to bars based on their count ranking, which could potentially confuse users. For example, in your example.ipynb, pickup_borough is displayed in green for Bronx, while dropoff_borough is in red, solely due to count variations for the same variable. Given that each bar already has a clear label, the additional colour coding might not be necessary and could be removed. (https://github.com/UBC-MDS/software-review-2024/issues/9#issuecomment-1916277295 - 3)
• plot_numeric @iris0614 (Nice to have - OPTIONAL)
  • You can enhance the EDA experience by offering scatterplots between the target variable (if numerical) and the numerical explanatory variables, catering to users who want to visualize the relationships before creating models for predictions. (https://github.com/UBC-MDS/software-review-2024/issues/9#issuecomment-1916277295 - 4)
• Ordinal? (For later)
  • Consider EDA for ordinal variables, I think "passengers" is visualized as an ordinal variable instead of categorical variable, as you've maintained the natural order of the number of passengers instead of ranking them as you did with other categorical variables. (see example.ipynb). (https://github.com/UBC-MDS/software-review-2024/issues/9#issuecomment-1916277295 - 5)

Badges

• The badges are not all all there, could consider all adding the 2 missing ones Continuous integration and test coverage, and Python versions supported (https://github.com/UBC-MDS/software-review-2024/issues/9#issuecomment-1915907137 - 5) (https://github.com/UBC-MDS/software-review-2024/issues/9#issuecomment-1916139577 - 4) (https://github.com/UBC-MDS/software-review-2024/issues/9#issuecomment-1916277295 - 1) @arturoboquin

Repo Improvements

• Although there is a clickable button that leads you to the documentation, I would suggest adding a link in the "About" section of the repo so that less experienced users don't struggle as much when trying to find it. (https://github.com/UBC-MDS/software-review-2024/issues/9#issuecomment-1917919802 - 2) @arturoboquin

README

• As of today, the installation instructions' title is "Installation (developers)". As a regular user, that made me think that I was looking into the wrong section and I searched for the "Installation (mortals)" section. As I didn't find one, I assumed that you chose this title as the package is still in development. However, I would remove the "(developers)" in the final version or create a regular user section and move the developer's instructions to the ReadTheDocs full documentation website. (https://github.com/UBC-MDS/software-review-2024/issues/9#issuecomment-1917919802 - 5) @phchen5

[rbouwer]

• any additional improvements (log in this issue)

[rbouwer]

COMMIT MESSAGE FORMATTING

fix: Feedback addressed by ...