Katherine Soderberg's project outline

[katherine-soderberg]

No description provided.

[leej3]

Sounds good. Try to break what you want to do into smaller chunks so that you can check them off as you go. It also means that at the end if you've only ticked off the first stepping stone you have a working program. Then rinse and repeat. Agreed about needing more python to know what you can and can't do. ask questions on the Gitter channel for pointers too.

[leej3]

Pasting update here for posterity:
I’m working on setting up my file structure (adding spreadsheets of data that I hope to filter/analyze) and hope to have a skeleton structure of code by next week. I have a sense of the outline of steps that includes 1) setting up the environment (importing pandas and other necessary packages), 2) loading in data (I’ll use pd.read_csv since my spreadsheets are in csv format), 3) using pandas methods to filter and reshape my data, and 4) turning my process into functions that can take different input files and perform various QC checks on them, in order to make the project useful for others in my research group

[leej3]

Do you need any help? Are you struggling to push updates to GitHub or debugging things for now?

[leesup]

Hello, do you need help with anything at this point? You can post questions here or bring questions to the class today.

[katherine-soderberg]

Thank you for checking in! I will update Github before this evening and bring debugging questions to class!

…

On Thu, May 7, 2020 at 12:21 PM Suhwan Paul Lee ***@***.***> wrote: Hello, do you need help with anything at this point? You can post questions here or bring questions to the class today. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#19 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AKDUJXIZRWNAD2SMKEL7VBDRQLN2BANCNFSM4K5GUUMA> .

[leej3]

Well done on passing the tests. Always a cause for celebration!

[leej3]

Nicely implemented project. Overall it achieves something useful in a clean modular, reusable way.

Obviously the tests could be more extensive. Getting them working full stop is great so well done for persevering with that but I encourage you to check out some of the other project to get a sense of the sorts of ways you can go about testing. In the long term, including tests as you develop code will make life much easier.

Some other minor points:

Your attention to python style was very good. There were a couple of time you slipped. Keep the style guide pep8 in mind. Revisiting it periodically allows you to constantly improve your style which will help others to interpret your code (and you will be able to quickly interpret the code of others inclined towards attention to such important details).

In general imports should occur at the top of a file. It prevents various annoying issues and makes your dependencies apparent to anyone with a quick glance at the top of a python module.

Also, adding comments within the code itself is a good idea. This is a nice guide. Code that is very obvious at the time of writing becomes a lot less clear to you a few months later. Be kind to future Katherine.