Wed, 04 Jan 2012
What I'm REALLY thinking about when I use your bioinformatics software
If you're like me, we pretend to care about the science in bioinformatics software. But what we really do is try to find reasons not to outright loathe the software -- because, lud knows, there are usually plenty of reasons to hate it.
In no particular order, here are the top 10 things I hate about your bioinformatics software. You know who I'm talking about.
- You posted it on SourceForge (and so I can't download the damn thing using a simple URL).
- You're not using version control (and hence are not a scientist).
- You put _ in the damned file name unnecessarily (that requires a shift key on my keyboard).
- fizbam-0.9.3.tar.gz either untars into the current directory, OR a directory named 'fizbam'. Alternatively, you named it fizbam-0.9.3-2011010101010101010101010101020.tar.gz and it untars into THAT monster of a name (and my ls goes off the screen).
- You have no README, or, if you do, it's a one-liner that refers to a URL (didn't I already download your damned software?) OR 5a. Your README file is in HTML (less is better than lynx, dontcha know?)
- Running 'make' rebuilds everything from scratch every time you run it (seriously?)
- There are neither tests nor examples; or, if there are, I can't run 'em, and even if they do run, I have no idea if the results are correct.
- The output is in some weird format and/or location (wait, I have to do a find to find the last file written, and then guess as to its format?)
- The command line options are poorly labeled and described, use random abbreviations, and/or are sensitive to order (unlike every good command-line parsing library written).
- You CaMEl-CaSED your software name so that not even tab completion can figure it out (program names should be all lower-case, as Darwin intended).
---
Post your top ten and send me the URLs... :)
--titus
posted at: 21:57 | path: /jan-12 | 7 comments
Comments:
Posted by Paul Agapow at Thu Jan 5 01:26:35 2012:
My complaints are more about the pragmatic issues of using software: <http://biocoders.net/groups/bioinformatics-and-computational-biology/forum/topic/what-im-really-thinking-about-when-i-use-your-bioinformatics-software/>
Posted by Ian Holmes at Thu Jan 5 02:20:22 2012:
Re point #8, see also http://biowiki.org/FileFormatDesign
Posted by Egon Willighagen at Thu Jan 5 04:02:54 2012:
Maybe talk to Cameron Neylon to write up a 'user perspective' for Open Research Computation?
BTW, SourceForge perfectly well allows deeplinking to downloadables with a single URL. I make use of that myself.
Posted by Preecha Patumcharoenpol at Thu Jan 5 04:40:44 2012:
I thing I hate most is ad-hoc fetch-and-build.sh
Posted by Ian Holmes at Thu Jan 5 05:32:53 2012:
That "file format design" list was actually a response to a less facetious (and far less amusing) post that is more relevant here
http://biowiki.org/BioinformaticsToolDesign
Posted by Aaron Quinlan at Thu Jan 5 07:51:31 2012:
Thanks for the chuckle. Unfortunately, I think my software suffers from a few of these - a resolution for the new year, I suppose.
Posted by Arend Hintze at Fri Jan 6 05:03:12 2012:
Don't forget:
linking to libraries that are not included and can't be found anymore
Cheers Arend