search

petrelharp / ftprime_ms

4 stars 2 forks source link

Edit pass #26

Closed jeromekelleher closed 6 years ago

jeromekelleher commented 6 years ago

This is an editing pass; changes outlined below. I don't think I'll get a chance to look at this again until next week, so if someone else wants to have a pass please go ahead.

changes:

  1. Removed the main pdf binary. This was making life very awkward during rebases as every commit ended up being a conflict with this blasted binary. So awkward in fact that it turns out I lost all of the actual content in the previous PR. Only the text and the figure are gone and they're easy enough to reproduce, but still very annoying. I'll see if I can dig up the original text and paste it in again, but it'll probably be next week before I get a chance.
  2. Editing pass through the introduction. This mainly involved moving stuff around. I moved some paragraphs, and pushed other things into the discussion. Feel free to undo if you disagree!
  3. Rewrote Alg W in terms of simplify and node and edge tables. I haven't coded this up, so it probably has some bugs. Also updated the description.
  4. Minor edits elsewhere.

As I was going through this it occured to me that the split between Results and Methods seems artificial. IMO this structure is a bit meaningless for this type of paper, and it would be much more natural not to enforce this structure. I made this point to PLoS for the msprime paper, but they insisted it have a Results section (but note there's no Methods).

Would anyone else agree with ditching the methods section entirely, and putting everything into Results? It's just a suggestion, but I think it would make the structure of the paper a lot simpler and more logical.

petrelharp commented 6 years ago

I think this is merged in, including the previous PR?

petrelharp commented 6 years ago

Good progress. I could make adjustments, but will wait 'til next week to make a serious editing pass.

petrelharp commented 6 years ago

Oh, right: about Results/Methods. Good job getting them to ditch it previously! Currently our "methods" section is three pages - the API discussion; something short about tables; and the simplify algorithm. The "results" is five plus figures.

I agree - I think it'd be nice to merge those in to a single section!