search

UBC-MDS / Dynamic33

Other
0 stars 0 forks source link

Fix issues with README #29

Open derekrodgers opened 8 hours ago

derekrodgers commented 8 hours ago

1:

Summary in README should include high-level interpretation of analysis findings, as well 1-2 sentences on what they might mean (at least at a high-level).

2:

README should include include instructions on how to run the analysis.

This last one doesn't make sense to me, because we did that, and it doesn't explain what we did wrong. I have submitted a regrade request for clarification.x

derekrodgers commented 8 hours ago

Ah, they gave more details in another section:

Usage documentation could be improved for clarity (i.e., it is not explicitly clear to the user how to use the project, or some of the wording is confusing, some guessing and/or trial and error had to be performed to run the project).

and

i know you're using an R project, so you don't need to do a lot of package setup things like the python folks. but just cloning the repository isn't enough instruction on how to run the analysis.

again we did have more instructions than this, so idk what they are talking about