-
-
Notifications
You must be signed in to change notification settings - Fork 38
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[REVIEW]: REvoSim v3.0.0: A fast evolutionary simulation tool with ecological processes #5284
Comments
Hello humans, I'm @editorialbot, a robot that can help you with some common editorial tasks. For a list of things I can do to help you, just type:
For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:
|
|
Wordcount for |
|
👋 👋 👋 @Euan-Furness @bramvandijk88 @emilydolson this is the review thread for the paper. All of our communications will happen here from now on. As a reviewer, the first step is to create a checklist for your review by entering
as the top of a new comment in this thread. These checklists contain the JOSS requirements. As you go over the submission, please check any items that you feel have been satisfied. The first comment in this thread also contains links to the JOSS reviewer guidelines. The JOSS review is different from most other journals. Our goal is to work with the authors to help them meet our criteria instead of merely passing judgment on the submission. As such, the reviewers are encouraged to submit issues and pull requests on the software repository. When doing so, please mention We aim for reviews to be completed within about 2-4 weeks. Please let me know if any of you require some more time. We can also use EditorialBot (our bot) to set automatic reminders if you know you'll be away for a known period of time. Please feel free to ping me (@Bisaloo) if you have any questions/concerns. |
Review checklist for @emilydolsonConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
@editorialbot check references The issue from #5284 (comment) should have been fixed by palaeoware/revosim#8. |
|
Review checklist for @bramvandijk88Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
I'm having some issues installing on both Ubuntu and Windows. See palaeoware/revosim#10 |
Alright I have spent one or two hours with the software, and it seems to be functional. I think found what appears to be a minor bug with the pathogen layer not being reset, but that should be easy to fix. I also tried to assess the other newly implemented functions, but I can't be sure it actually does what the authors claim without spending hours (debugging is a full-time job :)) In any case, I have left two checkboxes unticked. Firstly, as mentioned in the above comment, I found the installation instruction for Windows lacking. I am not a Windows person, so it could be that developers that like to use Windows (however many people that may be) are familiar with the protocol of using a QT environment with windows. However, in the steps described the final step (8) falls short. I know using C++ based software cross platform can be a pain in the neck, but if you want to have the claim your software can be installed across different operating systems, I would appreciate a little more explanation here. I also ran into an issue installing it on Ubuntu, which honestly was silly error on my side. That said, why not add the sentence "don't forget to run sudo apt-get update" and prevent the confusion altogether. Secondly, I left the automated tests box unticked. I am not entirely sure this is necessary for this project, but it feels weird to tick the box if they are not there. I leave this up to the handling editor. Then a small note to the authors: great job with this software. I have experimented with the earlier version, and the pathogen extension really excites me. I think a lot of biology starts making much more sense in light of pathogens/parasites, and I am looking forward to future publications with this framework. In fact, don't hesitate to suggest me as a reviewer for such future work! If the installation instructions are fixed (Windows step 8 more expanded, Linux reference to sudo apt-get update), I will tick these last boxes and I am supportive of publication. |
Thanks @bramvandijk88 & @emilydolson for your comments! @emilydolson, is your review still in progress or are you waiting for an action from the authors at this point? |
My review is in progress! I'll get it done soon - sorry for the delay. |
Hi @Euan-Furness @RussellGarwood 👋 👋, I would encourage you to already try to address the comments from the reviewers to keep the ball rolling.
Thanks, this is a great point! I do agree a full end-to-end testing suite would be very complicated and possibly not a priority for this project. However, I do believe that having continuous integration to verify that the software can be installed on all platforms given your instructions would be a serious improvement. I will open an issue in that sense in the repo. |
Thanks for the great comments @bramvandijk88. I just wanted to highlight I have already improved the windows instructions for build in the master branch - given the software comes with both a windows installer and a portable executable, I'm hopeful any windows users that actually chose to build it will be familiar with C++ development on Windows. As such I hope that is dealt with, but would welcome feedback to the contrary if you disagree! (I also added the sudo apt update to the Linux instructions - had the same thought). Great spot on the pathogen layer, thanks for that - a fix should be simple and is on my to do list. -- Secondly, I left the automated tests box unticked Indeed, our tests are not automated - but they are present through the GUI, in case you missed this (we wanted those to be visible to users so they could check REvoSim's functioning before using!) Thanks to drawing my attention to this process @Bisaloo - I've been away for most of the last month and had not flagged all the recent updates! |
Software/documentationThis seems like a useful piece of software, and all of the functionality worked as intended! I have opened an issue suggesting a few improvements to the documentation (including adding an example, as suggested in the review criteria). I checked the "testing" checkbox because the procedure for running tests is clearly documented and worked for me. That said, I'm also always in favor of adding automated testing where possible (it could just be a github action that automatically runs the same tests that a user could run locally). From a user perspective, if a package has automated testing, I am substantially more likely to trust it enough to use it in my research. I haven't checked off the "performance" box yet, because (as mentioned in my comments on the documentation) I feel like I don't have a good perspective yet for how iterations in this system map onto units of time in other systems. There aren't especially strong performance claims made in the paper, but they do say the system is efficient enough to ask questions about large scale macroevolutionary processes, so I'd just like to get a rough sense for how quickly it goes through generations before checking this one off. PaperThe paper is well-written and does a good job describing the newly added features. The only area where it is lacking is in the description of the current state of the field. I completely agree that this software fills a worthwhile niche (the combination of a full-featured GUI combined with relatively simple/efficient genomes that can be configured in a variety of ways). However, I was surprised to see the statement that "REvoSim is unusual in that it simulates evolutionary processes that occur within populations rather than just between them (Garwood et al., 2019), and is highly efficient, allowing long time spans and large population sizes on modest hardware." I'm definitely biased by the sub-field I'm in, but my impression is there are actually quite a lot of systems with these properties (although they make various tradeoffs between complexity and efficiency). I'm by no means suggesting that the authors need to refer to all of the following, but here are some examples of other systems that the authors may want to be aware of:
In case it's helpful, I reviewed a bunch more computational evolution platforms in this paper and am working on assembling more information on them in this wiki. Again, I don't think all of that needs to go in the paper, but I think it would be worth adjusting the discussion of the current state of the field to make it clearer to the reader what REvoSim's niche within the broader landscape is. In my mind, it does a fantastic job of occupying the space just left of digital evolution on this continuum (which is explained in more detail in the paper I linked to): Otherwise I'd say this is all looking very good! |
Hi @Bisaloo I know you suggested this before, but just to check, are you happy for us to make changes to the text of the paper on Github at this stage, to make improvements suggested by reviewers? I don't want to accidentally put people in a position of looking at lots of different versions of a document. If this is ok, I will start making suggested changes to the paper to address the current state of the field. |
Many thanks @emilydolson for the really useful comments - as per the above, @Euan-Furness will amend the paper as suggested, and I have noted the issue relating to documentaiton on the main repo. I'll be addressing all those issues in one go as soon as workload allows. |
Yes, it's fine, please go ahead 👍. Feel free to use editorialbot after to regenerate the paper and post a link here. |
@Bisaloo Correction made. |
@editorialbot check references |
|
@editorialbot recommend-accept |
|
|
👋 @openjournals/bcm-eics, this paper is ready to be accepted and published. Check final proof 👉📄 Download article If the paper PDF and the deposit XML files look good in openjournals/joss-papers#4518, then you can now move forward with accepting the submission by compiling again with the command |
I assume you don't need any further action from us @Bisaloo but if you do just shout, Thanks so much for your stewardship throughout - this has been a really positive experience! Thanks also @emilydolson and @bramvandijk88 for your reviews - much appreciated |
Yes, thanks for all the work you've put in @Bisaloo, @emilydolson, @bramvandijk88. |
@Euan-Furness I am the AEiC on this track and here to process final steps. I have checked your repository, this review, the archive link, and the paper, and most seems in order. I have only the following minor point which requires your attention:
|
@Kevin-Mattheus-Moerman UK now United Kingdom in the affiliations. Thanks for your work on this. |
@editorialbot generate pdf |
@Euan-Furness thanks for making that fix in the affiliations. One more point remains:
|
@Kevin-Mattheus-Moerman Apologies for the slow reply, I am not currently in the office. I believe this is now fixed. |
@Euan-Furness thanks. All looks good to proceed now. |
@editorialbot accept |
|
Ensure proper citation by uploading a plain text CITATION.cff file to the default branch of your repository. If using GitHub, a Cite this repository menu will appear in the About section, containing both APA and BibTeX formats. When exported to Zotero using a browser plugin, Zotero will automatically create an entry using the information contained in the .cff file. You can copy the contents for your CITATION.cff file here: CITATION.cff
If the repository is not hosted on GitHub, a .cff file can still be uploaded to set your preferred citation. Users will be able to manually copy and paste the citation. |
🐘🐘🐘 👉 Toot for this paper 👈 🐘🐘🐘 |
🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨 Here's what you must now do:
Any issues? Notify your editorial technical team... |
@Euan-Furness congratulations on this paper in JOSS! Thanks for editing @Bisaloo And a special thanks to the reviewers: @bramvandijk88, @emilydolson |
🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉 If you would like to include a link to your paper from your README use the following code snippets:
This is how it will look in your documentation: We need your help! The Journal of Open Source Software is a community-run journal and relies upon volunteer effort. If you'd like to support us please consider doing either one (or both) of the the following:
|
Submitting author: @Euan-Furness (Euan Furness)
Repository: https://github.com/palaeoware/revosim
Branch with paper.md (empty if default branch): JOSS
Version: v3.0.1
Editor: @Bisaloo
Reviewers: @bramvandijk88, @emilydolson
Archive: 10.5281/zenodo.8228938
Status
Status badge code:
Reviewers and authors:
Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) by leaving comments in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)
Reviewer instructions & questions
@bramvandijk88 & @emilydolson, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review.
First of all you need to run this command in a separate comment to create the checklist:
The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @Bisaloo know.
✨ Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest ✨
Checklists
📝 Checklist for @emilydolson
📝 Checklist for @bramvandijk88
The text was updated successfully, but these errors were encountered: