Hacker News new | past | comments | ask | show | jobs | submit login
Good enough practices in scientific computing (plos.org)
88 points by okket on June 24, 2017 | hide | past | favorite | 8 comments



One thing they mentioned in the 'left out' section is code review. I'm a researcher in a computation-heavy field and I think that anything I write that is intended to be used in our research group or used by other people should be code reviewed. In my experience, so many codes written by former group members or by senior group members become blackboxes that no one can read or maintain in five years.

Code review for anything more complicated than a script has helped the quality of what I write. It also ensures that there are other people who have at least seen the code that I wrote. Even if they don't fully understand it, they are at least empowered enough to wade through it if need be.


Apparently google rewite all code every three years.

https://arxiv.org/ftp/arxiv/papers/1702/1702.01715.pdf

2.11


I am there. We learn to please our master as our ancestors taught us in our rich oral tradition.

I hope that this undocumented and fragile big codebase dies before killing the PhD of some poor guy.


Oh, those citations:

> ... you have to explain the difference between plain text and word processing. And text editors. And Markdown/LaTeX compilers. And BiBTeX. And Git. ... the barrier to collaborating on papers in this framework is simply too high to overcome. Good intentions aside, it always comes down to, "just give me a Word document with tracked changes"

> ... Google Docs excels at easy sharing, collaboration, simultaneous editing, commenting, and reply-to-commenting.

Using google docs is not "good enough" practice for scientific computing. How will you embed parts of your csv files in the report, how will you at the same time have it included in the version control system? Using plain text file toolchains on the other hand could solve all that. Now they mentioned Markdown and Pandoc, but no mention of the ReStructuredText, Orgmode files or Asciidocs, so it makes me wonder why would they recommend version control and google docs?


I have used sharelatex.com to good effect with less-technical co-authors. They have everything listed for Google Docs (including change tracking, simultaneous editing, and commenting), and I don't have to help everyone else setup a LaTeX environment.


I have used overleaf with less technical co-authors. I'm not affiliated with them, but I really like their product. I can just send people a link and they can edit the text and see the PDF change. I also get version control.

But, with Mendeley and mathtype, I don't hate Word as much. It's a trade-off between version control and Word's track changes feature.


My experience of medical and biological research is that tracked changes in Microsoft Word using a file naming system that uses 'draft1', 'draft2', 'draftv1.2', 'final', 'finalfinal', 'final-feb' and other variations, is the only system I have seen.





Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: