emhart / 10-simple-rules-data-storage

A repository for the 10 simple rules data sharing paper to be submitted to PLoS Comp Biology
Creative Commons Zero v1.0 Universal
25 stars 13 forks source link

Reviewer 1 Comments #126

Closed emhart closed 8 years ago

emhart commented 8 years ago
karawoo commented 8 years ago

Regarding the comment about rules 4 and 5, maybe we should change rule 5 to something like "Data should be structured for analysis" or similar. We could cite Vince Buffalo's quote that one should "write code for humans, write data for computers" and move the paragraph beginning "To take full advantage of data..." up to the beginning to establish this point early on.

fmichonneau commented 8 years ago

I like your ideas @karawoo !

I think moving the paragraph starting with "To take..." at the beginning makes sense.

Initially, rule 5 was called "Data should be stored in a machine-readable format" and I think that calling it "structured for analysis" makes the intention behind this idea clear.

naupaka commented 8 years ago

I 3rd @karawoo's idea to rename Rule 5 and move the "To take..." paragraph to the top of the section. The current first paragraph under Rule 5 could almost fit better under rule 4, as well.

I think the antecedents for that VB quote include Donald Knuth (1984) in Literate Programming (italics in original)

Let us change our traditional attitude to the construction of programs: Instead of imagining that our main task is to instruct a computer what to do, let us concentrate rather on explaining to human beings what we want a computer to do.

and Martin Fowler (1999) in Refactoring: Improving the Design of Existing Code

Any fool can write code that a computer can understand. Good programmers write code that humans can understand.

karawoo commented 8 years ago

Ok, since several people are on board with this I'll create a PR later today and we can discuss it more there if needed.

On Sat, Apr 30, 2016 at 12:00 PM, Naupaka Zimmerman < notifications@github.com> wrote:

I 3rd @karawoo https://github.com/karawoo's idea to rename Rule 5 and move the "To take..." paragraph to the top of the section. The current first paragraph under Rule 5 could almost fit better under rule 4, as well.

I think the antecedents for that VB quote include Donald Knuth (1984) in Literate Programming (italics in original)

Let us change our traditional attitude to the construction of programs: Instead of imagining that our main task is to instruct a computer what to do, let us concentrate rather on explaining to human beings what we want a computer to do.

and Martin Fowler (1999) in Refactoring: Improving the Design of Existing Code

Any fool can write code that a computer can understand. Good programmers write code that humans can understand.

— You are receiving this because you were mentioned. Reply to this email directly or view it on GitHub https://github.com/emhart/10-simple-rules-data-storage/issues/126#issuecomment-215987435

emhart commented 8 years ago

The last of these have been taken care of with PR #137