sh-ih
commented
1 year ago Patricia,
Congrats on your first project! 🏆
Some comments:
- Repository structure: You have an organized repository and your file names are clear. A suggestion is to separate your encapsulated functions on the src folder and keep another folder called notebooks for your Jupyter notebook files.
You are missing the .gitignore file that was requested. You may not have needed here, but creating the .gitignore is one of the first steps on every project so you can keep all your working files on your local repo, but don't push them to Github.
- Data Cleaning Good job cleaning your data. The addition of comments on each step is very useful for you in the future and for other people checking your code. Keep doing that. I see that at the end you exported to csv your cleaned data, but that folder is not on your repo. The original dataset wasn’t supposed to be pushed to your repo, but your cleaned data did.
To avoid the Unnamed: 0 column on your csv, you need to add the index parameter:
final_sharks.to_csv("../data/final_sharks.csv", index=False)
- Visualizations The addition of titles to your visualization notebook helps a lot with clarity and you did a great job adding titles to your graphs. In the future, I would just pay more attention to the names of the axis, so those are just as clear as your titles.
Sometimes we have been working for so long with the data that we are clear on what act_class means, for example. But for someone seeing this for the first time it may be easier to see “Activity when attacked” or something similar to understand in an instant what the graph is about.
To complete the analysis on your notebook, it would have been nice to include a paragraph or two with your conclusion/answer to each of your questions, alongside your graphs, to show your interpretation of the results.
- Readme Your readme should be a way to fully get a gist of the project without browsing your files. A good Readme is crucial to show that you know how to document your work and make it available to others.
Here is one of example Fernando shared (https://github.com/Ironhack-data-bcn-oct-2023/lectures/blob/main/how-to/readme/readme-examples/graham-project-I.md).
Please try to improve your Readme. A great project can get overlook when the Readme is lacking information. The Readme is the opportunity to quickly show the results of all the work you did.
The link to the presentation you added to the Readme is not useful, because it is a local file path (the C:// is from your computer). To share files, always upload them somewhere so anyone can access them.. In this case, you can upload your pptx file to your Google Drive and then use that link on your READme.
- Bonus Next project won’t have as much cleaning work so you’ll be able to allocate more time to encapsulating your functions. It is a great way to improve your projects.
All in all, great job on this first project. Keep it up for the next one! đź’«
https://github.com/psaeztorres/PROJECT-1.git