-
-
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]: HARE: A Python workflow for analyzing genomic feature enrichment in GWAS datasets #6359
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 |
|
👋🏼 @ossmith @nfb1993 @abartlett004 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 (@jromanowska) if you have any questions/concerns. |
Dear @abartlett004 - are you still up for the review? Please generate your checklist to get started and don't hesitate to ask for anything by commenting here. |
Dear @nfb1993 - how is it going? I can see your generated checklist is formatted wrongly, maybe because you did that via email. Could you edit the comment above and try to fix that or perhaps generate the checklist once more, from GitHub? |
Dear Julia, indeed I generated the check list in the email, I was just testing. But thanks for pointing out that is not the correct way to do it. I will try to do the review as soon as possible. I will delete the wrong checklist message. |
Review checklist for @nfb1993Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Review checklist for @abartlett004Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Dear editorial team Thank you for the opportunity to review this paper. Overall, the documentation is well described and the manuscript states clearly the potential of the software. However, there are some boxes that I have not ticked yet, as the repository as it current state lacks of them. Also, I highlight some issues that I encountered when evaluating the software. Example of usage: Although the commands are clearly stated and the authors provide some testing scripts to verify installation, there is not a friendly example of how to use the software. I highlight that I was able to run a test example made by myself (I used a T2D publicly available GWAS summary statistics). It would be great if the author could add an small example with some examples of the expected main outputs. Community guidelines: the author provides where to address potential bugs and issues, however there is not statement for Software contribution i.e. if somebody external can contribute on the code. Correction necessary on the repository: The necessary dependencies for installation are listed, but the link to version of the human genome cache they recommend ((homo_sapiens_vep_105_GRCh37.tar.gz) ) is wrong. Correction needed on the software: When trying to run the preranking tool I encountered an error and crashed. The issue was that the time package was not imported. I had to add the line of code “import time” manually to make it work. Minor correction in article text: In line 81, “femur rations Using HARE, we decided…”, a dot seems missing. If these points are addressed, I would gladly recommend the software/article for publication. Side note, not necessary to approve the software: I would not mention Mac Os compatibility, unless it is thoroughly tested. I tried to test the software in an M2 silicon Mac with Ventura OS, I just could not make it run. I was not able to make the conda environment or install ENSEMBL tools. Furthermore, the ENSEMBL tutorial for MAC is outdated and not usable for silicon macs (probably it is for Intel based Macs). I do not think is the software fault. M2 Macs seem to have problems to run software in perl (almost not supported there) and certain c++ tools. These problems seem not to be in intel macs, hence, if possible I would try to test the software in a M1-2 Mac to be sure they are compatible. I was able to run the software very smoothly in a Unix environment. Best regards |
Thanks for the information! I see that this needs some actions from the authors, @ossmith. |
I mainly agree with Nicolas--the paper and documentation are both well-written and informative, and I would happily recommend the package for publication if the following minor issues are addressed. Each of the checklist boxes I have left unchecked is listed below along with the reason why: Installation: as Nicolas mentioned, the link to the recommended human genome cache is wrong. I think it is possible that the intended link is something like Community Guidelines: agree with Nicolas as stated above, need guidance for software contribution Example of Usage: I also recommend the inclusion of a small test dataset of inputs and expected outputs for each of the functions. Perhaps the data from Figure 2 from the paper would be suitable. Functionality: When a test dataset is included, I will be able to evaluate functionality |
Thanks for the detailed evaluations @nfb1993 and @abartlett004! I will work on these changes. |
👋 @ossmith - how is it going? Any problems? |
@jromanowska Thanks for checking in! We're finishing up an additional test suite (plus revisions above of course) and are hoping to be done and have pushed it in a few days. |
Dear @nfb1993, @abartlett004, and @jromanowska, We wanted to thank you again for reviewing our manuscript and software. Below we address the reviewers’ points and discuss the changes we have made in response. Please let us know if you have further thoughts or concerns. Example of usage: Although the commands are clearly stated and the authors provide some testing scripts to verify installation, there is not a friendly example of how to use the software. I highlight that I was able to run a test example made by myself (I used a T2D publicly available GWAS summary statistics). It would be great if the author could add a small example with some examples of the expected main outputs. Example of Usage: I also recommend the inclusion of a small test dataset of inputs and expected outputs for each of the functions. Perhaps the data from Figure 2 from the paper would be suitable. We have now added an example folder with a bash script for users as well as expected inputs and outputs. Community guidelines: the author provides where to address potential bugs and issues, however there is not a statement for Software contribution i.e. if somebody external can contribute on the code. Community Guidelines: agree with Nicolas as stated above, need guidance for software contribution. We have revised our Contribution Guidelines to clarify the process for external individuals to add or make changes to the code. Correction necessary on the repository: The necessary dependencies for installation are listed, but the link to the version of the human genome cache they recommend (homo_sapiens_vep_105_GRCh37.tar.gz) is wrong. Installation: as Nicolas mentioned, the link to the recommended human genome cache is wrong. I think it is possible that the intended link is something like https://ftp.ensembl.org/pub/release-105/variation/indexed_vep_cache/homo_sapiens_vep_105_GRCh37.tar.gz, but please confirm. We have corrected this link. Correction needed on the software: When trying to run the preranking tool I encountered an error and crashed. The issue was that the time package was not imported. I had to add the line of code “import time” manually to make it work. We have fixed this bug. Minor correction in article text: In line 81, “femur rations Using HARE, we decided…”, a dot seems missing. Resolved. Side note, not necessary to approve the software: I would not mention Mac OS compatibility, unless it is thoroughly tested. I tried to test the software in an M2 silicon Mac with Ventura OS, I just could not make it run. I was not able to make the conda environment or install ENSEMBL tools. Furthermore, the ENSEMBL tutorial for Mac is outdated and not usable for silicon macs (probably it is for Intel based Macs). I do not think it is the software’s fault. M2 Macs seem to have problems running software in perl (almost not supported there) and certain c++ tools. These problems seem not to be in Intel macs, hence, if possible I would try to test the software in a M1-2 Mac to be sure they are compatible. I was able to run the software very smoothly in a Unix environment. Thank you for raising this issue! We have revised the README to clarify that, while the software is able to run on Macs where dependencies can be installed, there may be VEP installation issues and the conda environment.yml file may not install it properly. As suggested, we have confirmed that HARE does run on a Mac M2 (Intel) running MacOS Big Sur 11.7.10 with successful installation of VEP. –- We also wanted to address this request from the pre-review thread from @ kdm9. We have added this functionality and tested it on GWAS data from the following non-human species: Bos taurus (vertebrate), Arabadopsis thaliana (plant), Drosophila melanogaster and Apis mellifera (metazoa), and Saccharomyces cerevisiae (fungi). BioMart, a HARE dependency, does not currently support bacteria or protists. –- Please let us know if you have additional concerns or comments once you are able to evaluate the tool. |
@nfb1993, @abartlett004 - could you comment on the work of the authors and on the responses they provided above? |
@abartlett004 - are you available soon to finalize the review process? |
Yes, I will have it done in the next week or so |
I confirm that I will finish the review within a week as well. |
Great, thank you @abartlett004 , @nfb1993 - there was apparently a problem with notifications being not sent when I was tagging you here. It seems to be resolved now. 👍 |
With the inclusion of the test data and examples, I am happy to recommend this for publication. Congratulations! One final note, however--it seems that the files described in Additionally, for whatever it's worth, I had similar difficulties as Nicolas in terms of installing HARE's dependencies on an M3 Mac running Sonoma, but it was fairly smooth on Windows/WSL. Definitely not the fault of HARE--Apple silicon just doesn't play nicely with the rest of the world, it seems :) |
@editorialbot check references |
|
@ossmith - I'm almost done with all the checks, but now I noticed one thing: why is Vagheesh Narasimhan marked as "corresponding author" if you have done all the submission work? I don't even think we require this mark... Another thing is that none of the other authors were active in the repo. This is fine as long as their contribution is not purely financial - check here and let me know that all is fine with the list of authors: https://joss.readthedocs.io/en/latest/submitting.html#authorship |
Hi @jromanowska - ah ok! We've removed the 'corresponding author' designation. We've also reviewed the guidelines and the other authors do meet the conditions for non-code-related authorship (e.g. project direction and code testing). Perhaps you already noticed this as well but the reason for the missing DOIs above is they are conference proceeding citations and not articles. |
@editorialbot generate pdf |
@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#5346, then you can now move forward with accepting the submission by compiling again with the command |
Thank you for the work, again, @ossmith , @abartlett004 , @nfb1993 - the paper and repo will now be checked for the final time by one of the editors in charge before the official acceptance. 🥳 |
@ossmith as AEiC for JOSS I will now help to process this submission for acceptance in JOSS. I have checked this review, your repository, the archive link, and the paper. Most seems in order, however the below are some points that require your attention:
|
@Kevin-Mattheus-Moerman Ok, we've fixed this! |
@editorialbot generate pdf |
@ossmith one more thing, can you please also complete the 3rd affiliation by adding the city and country (actually most use city, state, United States of America, for US affiliations, so consider extending like that). Thanks. |
@Kevin-Mattheus-Moerman Sure! We've changed the affiliations to be in this style. |
@editorialbot generate pdf |
@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... |
@ossmith congratulations on this JOSS publication !!!! Thanks for editing @jromanowska ! And a special thank you to the reviewers: @nfb1993, @abartlett004 !!! |
🎉🎉🎉 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: @ossmith (Olivia Smith)
Repository: https://github.com/ossmith/HARE
Branch with paper.md (empty if default branch): joss-submission
Version: v1.2.0
Editor: @jromanowska
Reviewers: @nfb1993, @abartlett004
Archive: 10.5281/zenodo.11154700
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
@nfb1993 & @abartlett004, 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 @jromanowska 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 @nfb1993
📝 Checklist for @abartlett004
The text was updated successfully, but these errors were encountered: