dondi / GRNsight

Web app and service for modeling and visualizing gene regulatory networks.
http://dondi.github.io/GRNsight
BSD 3-Clause "New" or "Revised" License
17 stars 8 forks source link

Status of GRNsight manuscript submission to PeerJ Computer Science #278

Closed kdahlquist closed 7 years ago

kdahlquist commented 8 years ago

The GRNsight manuscript was submitted to PeerJ Computer Science on May 18, 2016 with simultaneous submission to the PeerJ Preprint server. Submission ID is 10823.

It will now be checked by PeerJ staff, who will email me if any changes are required.
After passing checks, it will be assigned to an Academic Editor, who will invite reviewers to carry out peer-review.

Co-authors on the manuscript are going to get e-mails--you may need to do something to confirm your authorship.

The PDF that was generated for the review has been pushed to the repository as well.

dondi commented 8 years ago

Yay to us! I've confirmed authorship.

kdahlquist commented 8 years ago

Once it officially enters the review process and is live as a preprint, I'll create a news item about this.

kdahlquist commented 8 years ago

Over the weekend, I received several status update e-mails as follows:

  1. The manuscript passed staff checks and was sent on to be assigned an academic editor.
  2. I was asked to confirm that we wanted to submit it to the preprint server, to which I replied "yes".
  3. I was notified that the manuscript has been assigned to an academic editor (but not which one). It said that it will be sent out for review and we will be notified again when the reviews are in and the editor has made a decision.
  4. The preprint is now undergoing staff checks and after it passes, it will be published.
dondi commented 8 years ago

The preprint has been published! https://peerj.com/preprints/2068/

kdahlquist commented 8 years ago

We have received a decision on our manuscript. The letter from the editor and the reviews are found below. I will start parsing this into issues in the next few days.


Dear Kam,
Thank you for your submission to PeerJ Computer Science.
It is my opinion as the Academic Editor for your article - GRNsight: a web application and service for visualizing models of small- to medium-scale gene regulatory networks - that it requires a number of Minor Revisions.
Although never a guarantee, if you address the editorial changes below (from myself and the reviewers) there is a good likelihood the article will eventually be accepted.
You will also receive a staff email soon with any remaining technical changes to your submission. You must also address these changes before resubmission.
Although not a hard deadline, we expect you to submit your revision within the next 40 days.
With kind regards,
Shawn Gomez Academic Editor, PeerJ Computer Science


Editor's Comments MINOR REVISIONS

Please address the reviewer critiques, as both provided a number of comments as well as relevant potential additions/modifications (e.g., export capability, package accessibility, etc).


Reviewer 1 (Anonymous)

Basic reporting
No Comment

Experimental design Dahlquist et al present GRNsight, a service for visualising gene regulatory networks of the ‘small-to-medium-scale’. The tool is available via a web application and the source code is also provided. On receiving a manuscript such as this I immediately try and use the application and I compare it to my current preferred tools in the domain. The web application loads quickly and is reasonably intuitive to use. It is not so clear that the force algorithm is disabled on specific nodes once that node has been manually relocated to a new position. This may be described under the help section, but I could not find it although it is mentioned in the manuscript (line 217). The visual style of the network is good. Certain behaviours of the visualisation are not compatible with internet explorer (which the authors do not mention is supported � line 239). However,, the only platform for which mouse over on links revealed the underlying weights was firefox on windows 7. Neither safari, chrome not firefox on OSX or Chrome on windows 7 showed the weights. I would like to see an option on the tool for showing or hiding all weights.

Validity of the findings My two preferred tools for laying out networks are BioTapestry (http://www.biotapestry.org/) and YeD (http://www.yworks.com/products/yed) . In neither case could I see a simple way to import the information from the excel file specified by the authors as output from the GRNmap package to reproduce the visualisation that they show in GRNsight. The specific issues are weighted networks � neither of these packages provide a direcct method of importing these data from a matrix in excel. However GRNsight itself does not work directly from a matrix � rather it parses that network through JSON. The central constraint for GRNsight is the file format output by GRNmap. I could write a parser for that matrix into a format such as GraphML and then import that in to YeD and have far more tools available to me.

The authors themselves recognise this to some degree and argue that their tool is aimed at doing one thing well. I agree that this tool does present a network from GRNmap well. However, given the existence of 47 other tools which already do something similar it must be an exceptionally good tool. I am familiar with cytoscape, but not Gephi and so tried Gephi to visualise a network similar to that presented here. It is possible, but as the authors state non-trivial.

Whilst I agree that simplicity is key (cognitive load � line 103) II am less clear about the ‘understanding the biological results of the model’ enabled by GRNsight. The authors discuss these on lines 281-289 giving generalised interpretations of issues such as feed forward motifs, highest in-degree and the regulatory chains. Yet as far as I can see, these are all determined by visual inspection. Furthermore none of these rely on the weights, which the distinguishing feature of GRNsight. I would be able to identify these more easily in a system such as YeD and do not require the weight information to do so � a simple sif file format givving the directionality between two nodes is sufficient.

The visualisation of the weight parameters described in lines 290-322 is the key behaviour here. Figure 5 D,E show clearly the impact of the addition of this weight information, yet E is the clearest visualisation and the only node within it that is located in anything close to its original position is Ace2 � almost every other node has been moved by hand. This revveals a flaw in the implementation of the force-spring layout algorithm as applied in GRNsight. Given the small area of the view port and the constraint that all nodes remain within it, the layout is sub optimal as the force-spring cannot reach its most relaxed state. Furthermore when looking at figure 5 I am always drawn to panels C and F as being the most informative view. Thus I would argue that the force-spring algorithm used here does not provide much benefit to the layout of the network other than separating nodes from one another. The useful layout requires manipulation. Taking the network from E and recreating it in YeD revealed that just a hierarchical clustering and layout gets you closer to E without any manual intervention.

Comments for the Author
Ultimately the tool presented here is useful for interpreting the results of GRNmap, but I would be unlikely to use it in any other situation. As it does not accept a standard input file type, the output of any other network analysis package requires conversion in to the matrix format required here. Similarly, the tool provides no export function (the option in the File menu remained stubbornly greyed out) and so I can’t take a network from GRNsight and utilise it elsewhere. I also can’t use GRNsight to convert the GRNmap format to something I might like to use elsewhere. GRNmap itself looks to be a very interesting package and I would like to explore it further, but I would be looking at converting its output into something I could use in a number of other pipelines.

The authors refer to future features coming in version 2 (lines 323-329). I encourage them to consider implementing at least one standard filetype for displaying graph data within their tool. Be it sif, graphml or even gml, it would significantly increase the utility of the tool as it currently exists. Alternatively this tool not be considered stand alone from GRNmap.

My comments are rather focussed on the tool and its usability, less on the manuscript itself. The manuscript is generally well written and clear. It’s weakness lies in the arguments about biological insight derived from the visualisation. If I were to parse the matrix into a graphml file format, I could visualise these networks (complete with weightings and line endings etc) in a wide array of tools and � I would argue �– extract more biological value from the interpretation. I would encourage the authors to expand on this section of the manuscript if possible.


Reviewer 2 (Manuel Corpas)

Basic reporting

The article "GRNsight: a web application and service for visualizing models of small- to medium-scale gene regulatory networks" is well written and documented. I have found disappointing the level of review of other similar network visualisation tools that exist out there. They only provide comparison agains Cytoscape and Gephi. They do not refer (at least in the introduction) to the Cytoscape.js web application, only to the console application. This to me raises concerns in an otherwise exhaustive work, providing ground for not having extensively researched other similar tools in the field, which is quite crowded. A search in the BioJS registry (http://biojs.io/; an NPM based repository of biological web application) of the word "network" retrieves 12 components. Not all of them are necessarily relevant for this publication, but at least some of them should be compared against and a case should be made so that it is made apparent how GRNsight provides valuable new functionality that is not redundant.

You do mention Cytoscape.js in line 175 but the justification of creating GRNsight because of the future possibility of implementing other D3.js visualisations is not well founded in my opinion. The http://biojs.io/d/biojs-vis-interactions-d3 network visualisation component does use already D3 for network visualisation.

The supplementary figures are very helpful to the understanding of the article.

Experimental design
N/A

Validity of the findings
I am not sure that the visualisation of 75 nodes or 150 edges is the kind of magnitude that would be valuable to many potential users. I would find it more impressive if the capacity to render nodes was in the order of thousands (even though this may be impractical to visualise and some data reductions might be necessary).

To me the bits that I have found most useful for the tool are:

I would have also liked some more emphasis on the "findable" and "reusable" aspects of open source software principles. I do believe some mention to "FAIR" principles could be useful: Findable, Accessible, Interoperable, Reusable. This has been done with data sharing (http://www.nature.com/articles/sdata201618) but this applies to software.

Comments for the Author Bioinformatics web tools like GRNsight are published in the literature but they are not made accessible via a centralised repository like the BioJS registry. I would thoroughly recommend authors to make accessible their tool via the BioJS registry. The requirements for making a package accessible through the BioJS registry are minimal:

If the authors had searched the BioJS registry for the keyword "network" they would have found components that could have at least compared against. By not checking the BioJS registry and not including GRNsight in it they have missed the opportunity to increase the exposure of their tool and potentially lose valuable engagement with a community of reference who might even keen to contribute to the code. It is thus important to appear that this tool is not coded in isolation.

kdahlquist commented 8 years ago

I received an e-mail today from PeerJ saying that no technical changes were required for our manuscript and that we just need to address the editorial changes found in the previous comment on this issue.

kdahlquist commented 8 years ago

I'm working on breaking out the feedback from the reviewers into individual, actionable issues. My draft of the response to the reviewers where I'm starting with a copy of the reviews will be deposited to the repository shortly.

kdahlquist commented 8 years ago

I've gone through the reviewers comments and made or updated issues related to their comments. They are all priority 0.5 for the moment until we decide what we are going to tackle first at our meeting today. There are other things to address in the manuscript, but I only made issues that would require changes to the code or website. The related issues are:

These issues are beyond the scope of what we can accomplish in the time window for revising our manuscript:

kdahlquist commented 8 years ago

I have finished an initial pass through the response to reviewers and pushed it to the repository. I have referenced issue numbers throughout and there are a couple questions for @dondi also highlighted in green. I wrote it as if we have implemented all requested features/changes, but we might need to revise based on what we can actually accomplish.

I created two new issues, #290 and #291 that are in response to Reviewer 2, but are probably beyond the scope of what we can reasonably accomplish in the next few weeks.

There is a list of issues having to do with the code and documentation listed in a previous comment. Here is a list of tasks @kdahlquist needs to tackle from within the manuscript:

kdahlquist commented 8 years ago

Work tonight: added discussion of F, A, and I of FAIR to manuscript. Wrote executive summary section of response to reviewers, did a little minor reformatting.

Note to self: situated knowledges: https://conceptsinsts.wikispaces.com/Situated+Knowledges+(Schaffer)

kdahlquist commented 8 years ago

The response to reviewers is essentially done and pushed to master. @dondi, please take a look. Three things to look out for:

  1. My discussion of GraphML in terms of the technical language
  2. A reference to Tufte (highlighted in greeen)
  3. I think I captured all of our discussion from yesterday, but especially please look it over for tone.

There is one section that I have not completed which has to do with discussing the "47" other tools. I left that out for the moment because I want to work on the manuscript before returning to that in case I run out of time.

So, I'm moving on to the manuscript for tonight and tomorrow. I still need to finish the FAIR section, edit the biological interpretation section, and deal with the Intro, so quite a bit of work still.

Please do chime in with something from Tufte, soon. Thanks.

dondi commented 8 years ago

There are some Tufte quotes from this section of the Wikipedia page on Data Visualization that may fit the bill (they cite the primary source in case we use them). I particularly like the conclusion of the bulleted quote, which says “Graphics reveal data. Indeed graphics can be more precise and revealing than conventional statistical computations.”

There are also some non-Tufte sources on this Stanford Data Visualization course. Perhaps the campus library access privileges can deliver full-text versions of those. The Card/Mackinlay/Shneiderman reference should be pretty authoritative if there is a good quote from there; those three are pretty seminal folks in visualization/interaction design. (van Wijk is no slouch either, but I just happen to be more familiar with Card/Mackinlay/Shneiderman)

dondi commented 8 years ago

OK, modifications/revisions have been made to the cover letter, reviewer response, and text-only paper. I turned on Track Changes on all documents to make it easy to spot differences:

Figure 4 has been updated and pushed to the repository, replacing the prior version.

kdahlquist commented 8 years ago

I've got to go home. I'm not finished, so I'll definitely need tonight and tomorrow to get all of this wrapped up. I'll see what I can do tonight, but most likely I'll be in the office tomorrow. I've pushed what I've got so far. The FAIR discussion is long and rambly still and I need to clean it up. The problem I am having is that if I do it justice, it has to be long. I also added some stuff about web service persistence that I thought was applicable.

dondi commented 8 years ago

OK, I have done a read-through of it, and pushed revisions/wordsmithing/comments via track changes. Ultimately I did not change much; the early portion feels pretty solid and flows well. The latter sections have a little more, but in the end I did not see any dealbreakers, just minor tweaks and wordsmithing. Hope this last push goes well!

kdahlquist commented 8 years ago

OK sounds good. I'm in the office. I'm going to finish this off and submit. I'll post updates on my status here.

kdahlquist commented 8 years ago

I've pushed the latest revision. I'm going to eat lunch and go through it one last time for (hopefully) minor tweaks, and then fix the references.

If @dondi has time, you could look at the FAIR stuff, especially the interoperability section to make sure that I didn't screw up the discussion of GraphML. However, if you don't have time, I'm fairly (ha, ha) confident it's OK.

dondi commented 8 years ago

Sorry, wasn’t able to sit with it until now but just wanted to let you know I’m looking at the FAIR section at the moment. You are likely working as well so let me know what may be the best way to integrate any changes I might find. I’m thinking that maybe I should just email you my version rather than committing, in order to avoid conflicts.

kdahlquist commented 8 years ago

No worries. Just pushed my last wordsmithing. I'm now working on the references. You could e-mail if the changes are extensive or comment here, whichever is easier.

dondi commented 8 years ago

Ah OK. It looks like I am working on the latest version then—the most recent commit that I see is "finish discussion of FAIR principles." In that case, I have been revising the latest version and so it looks safe to send this one via commit/push when I am done with it.

kdahlquist commented 8 years ago

no--there should be one more version

dondi commented 8 years ago

Oh....not seeing that commit on the GitHub website then.

kdahlquist commented 8 years ago

Sorry, typed my password wrong and it didn't push. Try now. If you e-mail me your changes, I'll incorporate. Probably easier all around. My changes were all wordsmithing, so we may have touched the same things.

dondi commented 8 years ago

OK got it. Will email instead.

dondi commented 8 years ago

Email sent (with attachment, adding my name to the end to avoid confusion).

kdahlquist commented 8 years ago

Got to the final stage of uploading everything and saw that they require a manuscript with tracked changes. I had overlooked this, thinking that they wanted a rebuttal letter or a tracked changes manuscript. I'll have to generate this manually looking at the two versions. I think I need to go home for dinner; I'll do this later tonight. We've got about 13-14 hours left on the clock...

kdahlquist commented 8 years ago

Forgot to upload new screenshot figure, too.

dondi commented 8 years ago

Arg, so sorry to hear about these last glitches…but at least it looks pretty close now.

kdahlquist commented 8 years ago

My little one is finally asleep so I'm on the home stretch. Next update when it's submitted.

kdahlquist commented 8 years ago

IT IS SUBMITTED!!!

Reviewing PDF pushed to repository here: https://github.com/dondi/GRNsight/raw/master/documents/manuscripts/peerj-computerscience-2016/revisions/peerj-reviewing-10823-v1.pdf

Resisting the urge to close this issue: instead will change label from priority 0 to ongoing.

Forgot to add with a whole 10 hours to spare!

dondi commented 8 years ago

YES! Cheers and a big exhale :)

True, sounds appropriate that we keep this open until it is truly and officially published. But for now, kudos on the accomplishment and now it's out of our hands 💯

kdahlquist commented 8 years ago

The submission passed staff checks (actually as of yesterday) and has been passed to the Academic Editor.

kdahlquist commented 8 years ago

Noticed that updating our preprint with the revised version of the manuscript was not automatic. I've e-mailed to get instructions on how to proceed.

kdahlquist commented 8 years ago

So, submitting revisions to the Preprint are manual. I just submitted the revised version.

kdahlquist commented 8 years ago

The new version of the preprint is live! https://peerj.com/preprints/2068/

dondi commented 8 years ago

I've gotten my basic membership, and I just wanted to report that the payment page that I saw had the full list that you mentioned.

kdahlquist commented 8 years ago

The GRNsight paper has been accepted for publication! Congratulations to us all!

The next step is a list of Production Tasks from the PeerJ staff and after we complete that, the proofs.

A reminder to @bengfitzpatrick to pay the membership fee ASAP; I'll take care of mine today.

dondi commented 8 years ago

Woohoo! 👍 💯 That was pretty good turnaround. Hope the Production Tasks are largely by-the-numbers type work that we can just power through. Release party release party release party 🍻🍷🍸🍹🍾

kdahlquist commented 8 years ago

I confirmed with the publisher that we would like to publish the reviews and response to authors with our article. The production editor says that we should receive the proofs in about 10 business days.

kdahlquist commented 8 years ago

Proofs are here. @dondi and I will review and return ASAP.

dondi commented 8 years ago

OK, the updated architecture diagram is there, in revisions/figures.

kdahlquist commented 8 years ago

Got it, although now I'm wondering whether the export to SIF and GraphML somehow needs to be annotated on this as well. I can ask them for another day if this is too much to deal with right now. I'd rather take the time and get it right than rush it. Let me know.

dondi commented 8 years ago

OK, let me see if I can get to it when I'm back in the office. Shouldn't take too long, though I'll note that in terms of connections, it would be more like the JSON goes back to the server which then produces the exported file. So this will entail new edges, and not relabeling of existing ones.

kdahlquist commented 8 years ago

OK. I thought it might be a little more complicated. Like I said, I can ask for another day if need be. It's more important to get this right than to rush to get it back today.

dondi commented 8 years ago

OK, I managed to put something up there but will need to finalize my course prep now. Maybe it’s good to ask for that extra day anyway because I made some choices on this version that might need revision or discussion. Take a look and see how it strikes you.

kdahlquist commented 8 years ago

At first glance, it looks OK. But, I am going to e-mail PeerJ and ask for the extra day so that we have a chance to talk about it later at the GRNsight meeting.

dondi commented 8 years ago

OK, I finally managed to get some sit-down-and-tweak time with the diagram, and I’ve pushed what I could manage. I couldn't get the edges to curve exactly as in the sketch, but the diagram is still an improvement from before.

As for a revised caption, how about:

GRNsight architecture and component interactions. The server provides a web API that accepts files in Microsoft Excel workbook (.xlsx), SIF (.sif), and GraphML (.graphml) formats and converts them into a unified JSON representation. A converse import function accepts this JSON representation and converts it into either SIF (.sif) or GraphML (.graphml) formats. The web application server provides code and resources for the graphical user interface that displays this JSON representation of the graph.

kdahlquist commented 8 years ago

Thanks, it looks good. I'll get this submitted later today.

kdahlquist commented 8 years ago

The annotated proof, revised Figure 3, and document explaining the changes have been uploaded to PeerJ.

kdahlquist commented 7 years ago

It gives me great pleasure to announce that our article has been published!!!

https://peerj.com/articles/cs-85/

Spread the word about the seminar @kdahlquist is giving on Friday, September 16 at 3:00 in LSB 120 and the Release Party afterwards on the LSB 2nd floor terrace!

With a record 49 comments, I'm closing this issue :)