CarterColeman / CARTERCOLEMAN_MADA_PROJECT

0 stars 1 forks source link

part 3 feedback #3

Open andreashandel opened 2 years ago

andreashandel commented 2 years ago

please clean up further, e.g. having 'data' and 'data_dir' is somewhat confusing. also, main level readme should give a brief overview of what's where and how to go about reproducing things.

While you have some explanatory text in the Data_exploration script, a bit more would be good. right now it states what you do, but not why. More text, like a running commentary of your thinking could be useful.

Project_Code_dump didn't run, not sure if it was supposed to. If you got code bits just for yourself, that's fine but mark them somehow, e.g. by writing a sentence at the beginning explaining that this is just a file that collects code or such. and/or stating that in the readme file.

your manuscript should not contain code, just text and results. and i suggest having only the main results in the main text, and additional results (figures/tables) in the supplement. E.g. most exploratory figures, unless they are part of the main story.

Overall, I think you still got some work to do further cleaning up/structuring things, but other than that, looks like the project is on track.

CarterColeman commented 2 years ago

Dr. Handel,

Thank me for the feedback. I am seeing that I was still confused on how detailed/what kind of detail needed to be included. I will work on getting everything cleaned up.

Additionally, you are not supposed to be able to run the code dump. That was just something I wrote to potentially remove outliers and re-run linear models as a part of the analysis script. I just didn’t want to totally delete it just yet. I will make sure that is properly labeled/explained.

Thanks, -Carter

Get Outlook for iOShttps://aka.ms/o0ukef


From: Andreas Handel @.> Sent: Tuesday, November 2, 2021 9:03:55 AM To: CarterColeman/CARTERCOLEMAN_MADA_PROJECT @.> Cc: Subscribed @.***> Subject: [CarterColeman/CARTERCOLEMAN_MADA_PROJECT] part 3 feedback (Issue #3)

[EXTERNAL SENDER - PROCEED CAUTIOUSLY]

please clean up further, e.g. having 'data' and 'data_dir' is somewhat confusing. also, main level readme should give a brief overview of what's where and how to go about reproducing things.

While you have some explanatory text in the Data_exploration script, a bit more would be good. right now it states what you do, but not why. More text, like a running commentary of your thinking could be useful.

Project_Code_dump didn't run, not sure if it was supposed to. If you got code bits just for yourself, that's fine but mark them somehow, e.g. by writing a sentence at the beginning explaining that this is just a file that collects code or such. and/or stating that in the readme file.

your manuscript should not contain code, just text and results. and i suggest having only the main results in the main text, and additional results (figures/tables) in the supplement. E.g. most exploratory figures, unless they are part of the main story.

Overall, I think you still got some work to do further cleaning up/structuring things, but other than that, looks like the project is on track.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHubhttps://github.com/CarterColeman/CARTERCOLEMAN_MADA_PROJECT/issues/3, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AVITVC6FU3JVAH6QR35LL2TUJ7VUXANCNFSM5HGNBS7Q.