Closed editorialbot closed 1 year ago
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:
@editorialbot commands
For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:
@editorialbot generate pdf
Software report:
github.com/AlDanial/cloc v 1.88 T=0.14 s (1674.9 files/s, 208634.8 lines/s)
-------------------------------------------------------------------------------
Language files blank comment code
-------------------------------------------------------------------------------
JSON 31 0 0 8342
JavaScript 73 973 275 5144
Vuejs Component 40 491 69 4500
Python 43 1207 719 3446
Markdown 10 418 0 1012
SVG 6 0 2 737
YAML 12 46 1 495
Bourne Shell 10 102 54 403
CSS 3 63 45 295
TeX 1 13 0 218
Dockerfile 3 6 6 47
HTML 1 0 1 18
INI 1 0 0 1
-------------------------------------------------------------------------------
SUM: 234 3319 1172 24658
-------------------------------------------------------------------------------
gitinspector failed to run statistical information for the repository
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):
OK DOIs
- 10.1093/genetics/iyac022 is OK
- 10.1093/bioinformatics/btu613 is OK
- 10.1093/nar/gkx1098 is OK
- 10.1186/s13059-016-0974-4 is OK
- 10.1093/nar/gkaa1043 is OK
- 10.1093/nar/gkl993 is OK
- 10.1093/nar/gkac888 is OK
- 10.1093/nar/gkx1153 is OK
- 10.1093/nar/gku1205 is OK
- 10.1101/gr.176601 is OK
- 10.1038/nmeth0410-248 is OK
- 10.1093/nar/gkv1189 is OK
- 10.1186/s13073-021-00835-9 is OK
MISSING DOIs
- None
INVALID DOIs
- None
Wordcount for paper.md
is 1653
:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:
Howdy @suragnair and @JDRomano2!
Thanks for agreeing to review this submission.
The process for conducting a review is outlined above. Please run the command shown above to have @editorialbot generate your checklist, which will give a step-by-step process for conducting your review. Please check the boxes during your review to keep track, as well as make comments in this thread or open issues in the repository itself to point out issues you encounter. Keep in mind that our aim is to improve the submission to the point where it is of high enough quality to be accepted, rather than to provide a yes/no decision, and so having a conversation with the authors is encouraged rather than providing a single review post at the end of the process.
Here are the review guidelines: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html And here is a checklist, similar to above: https://joss.readthedocs.io/en/latest/review_checklist.html
Please let me know if you encounter any issues or need any help during the review process, and thanks for contributing your time to JOSS and the open source community!
Hi @suragnair and @JDRomano2
Do you think you'll have a chance to begin your reviews soon?
@SeriousHorncat would it be possible to include either a link to a demo website (pre-populated with a few examples) or a video covering basic usage in the GitHub README? This would allow potential users to get a quick overview of the functionality and how to use Rosalution.
@JDRomano2 can we get an update on your progress?
@jmschrei I'll have the review completed tomorrow. Thanks for your patience!
@SeriousHorncat I agree with @suragnair - I've been struggling to get the software running on my local computer. I think two things would significantly help:
To provide a bit more information about the issue I'm experiencing, after following all of the deployment instructions I'm seeing a 404 page not found
message when I navigate to localhost:80
in my browser.
Nothing in the logs suggests the cause of the issue. E.g., for rosalution-frontend-1
:
2023-07-01 09:11:07 yarn run v1.22.5
2023-07-01 09:11:07 $ vite --host 0.0.0.0 --port 80
2023-07-01 09:11:07
2023-07-01 09:11:07 VITE v4.0.4 ready in 241 ms
2023-07-01 09:11:07
2023-07-01 09:11:07 ➜ Local: http://localhost:80/
2023-07-01 09:11:07 ➜ Network: http://172.18.0.2:80/
and for rosalution-backend-1
:
2023-07-01 09:11:08 INFO: Will watch for changes in these directories: ['/app']
2023-07-01 09:11:08 INFO: Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
2023-07-01 09:11:08 INFO: Started reloader process [11] using WatchFiles
2023-07-01 09:11:08 INFO: Started server process [13]
2023-07-01 09:11:08 INFO: Waiting for application startup.
2023-07-01 09:11:08 INFO: Application startup complete.
Please note that I am satisfied with all other aspects of the study. If the authors are able to provide a usable example and improve documentation such that I can get everything running locally I should be able to assess the outstanding items in the checklist.
I do feel that this is within the scope of JOSS and is a valuable contribution to the field.
@SeriousHorncat would it be possible to include either a link to a demo website (pre-populated with a few examples) or a video covering basic usage in the GitHub README? This would allow potential users to get a quick overview of the functionality and how to use Rosalution.
@suragnair I meant to follow up on this sooner, we appreciate your patience. We agree a video demonstrating the basic usage of the application would be extremely helpful. @lizworthey-cgds and are reviewing a case that would be a good example to use in a demonstration video. We will follow up once we have a demo video prepared.
@SeriousHorncat I agree with @suragnair - I've been struggling to get the software running on my local computer. I think two things would significantly help:
- Provide troubleshooting details for deployment
- Stand up a public demo server that will allow users to quickly explore the core functionality of the software.
To provide a bit more information about the issue I'm experiencing, after following all of the deployment instructions I'm seeing a
404 page not found
message when I navigate tolocalhost:80
in my browser.Nothing in the logs suggests the cause of the issue. E.g., for
rosalution-frontend-1
:2023-07-01 09:11:07 yarn run v1.22.5 2023-07-01 09:11:07 $ vite --host 0.0.0.0 --port 80 2023-07-01 09:11:07 2023-07-01 09:11:07 VITE v4.0.4 ready in 241 ms 2023-07-01 09:11:07 2023-07-01 09:11:07 ➜ Local: http://localhost:80/ 2023-07-01 09:11:07 ➜ Network: http://172.18.0.2:80/
and for
rosalution-backend-1
:2023-07-01 09:11:08 INFO: Will watch for changes in these directories: ['/app'] 2023-07-01 09:11:08 INFO: Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit) 2023-07-01 09:11:08 INFO: Started reloader process [11] using WatchFiles 2023-07-01 09:11:08 INFO: Started server process [13] 2023-07-01 09:11:08 INFO: Waiting for application startup. 2023-07-01 09:11:08 INFO: Application startup complete.
@JDRomano2
Additional and clearer documentation on how to visit the application, along with additional documentation on debugging common deployment issues, would be incredibly helpful. I will create an issue in our repo to track this. https://github.com/uab-cgds-worthey/rosalution/issues/105
We are discussing amongst the maintainers and our PI the potential for a demo site. We would need to remove certain features such as uploading new cases; since that could potentially put a strain on the 3rd party APIs. We try to be careful and limit the potential vectors of misuse of the application.
In the meantime, lets try to help get y'all deploying the application on your machines. We want to help continue to remove barriers for future contributors.
After running the following docker compose command in the code block below, could you visit http://local.rosalution.cgds/rosalution/
and the http://local.rosalution.cgds/rosalution/api/docs
instead of visiting localhost:80
? Do you see a login screen that looks like this picture?
docker compose up --build
If this does not work, could you share the results of the ./setup.sh
and the docker ps
commands from below?
./setup.sh clean
docker compose down
docker system prune -a --volumes # This will also remove other docker images but it's the fastest way to clear old images
docker compose up
docker ps
note: run the below code block in the project root folder of Rosalution
@suragnair I know you've been travelling recently, but can you provide an update when you're back?
@JDRomano2 have you had a chance to try out the above suggestions?
@suragnair @JDRomano2 checking in on this again. Have you been able to complete your reviews?
Sorry for the delay! I was able to successfully install and get Rosalution running. The only items that remain are:
Sorry for the delay! I was able to successfully install and get Rosalution running. The only items that remain are:
- A researcher friendly user guide or video that @SeriousHorncat mentioned they are preparing
- This has been perfect timing. We have finished preparing our first pass for a demonstration video of how Rosalution is being currently used - https://uab.app.box.com/s/r76kbgsmu2w562akfvdcfhutu2jwe6u3 , we have updated our README.md to include a link out to the demonstration video.
- a comment on the state of the field in the manuscript
- Originally we planed to update the Statement of Need section, but it just kept growing, so we opted to add a whole section dedicated to the State of the field https://github.com/uab-cgds-worthey/rosalution/pull/134 https://github.com/uab-cgds-worthey/rosalution/issues/87. So these changes are included now
Please let us know if there is anything else we can do to help facilitate this review more.
@editorialbot generate pdf
:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:
Great, thanks. @jmschrei I have finished my review, all clear!
I have now completed my review as well and am fully satisfied with the revisions! Thanks for the updates, @SeriousHorncat !
@suragnair and @JDRomano2 Thank you so much for investing your time for reviewing Rosalution. We at @uab-cgds-worthey are grateful for the feedback which helps reduce barriers for future contributors of Rosalution. Also, @jmschrei thank you for your time as editor to help this review process proceed smoothly.
Rosalution has a tag and release for version 0.6.0. What are the next steps necessary to help move this submission forward?
@JDRomano2 thanks for the review! If you're satisfied would you mind checking all the boxes in your review?
@editorialbot set <DOI here> as archive
@editorialbot set <version here> as version
@editorialbot generate pdf
@editorialbot check references
and ask author(s) to update as needed@editorialbot recommend-accept
@editorialbot check references
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):
OK DOIs
- 10.1093/genetics/iyac022 is OK
- 10.1093/bioinformatics/btu613 is OK
- 10.1093/nar/gkx1098 is OK
- 10.1186/s13059-016-0974-4 is OK
- 10.1093/nar/gkaa1043 is OK
- 10.1093/nar/gkl993 is OK
- 10.1093/nar/gkac888 is OK
- 10.1093/nar/gkx1153 is OK
- 10.1093/nar/gku1205 is OK
- 10.1101/gr.176601 is OK
- 10.1038/nmeth0410-248 is OK
- 10.1093/nar/gkv1189 is OK
- 10.1186/s13073-021-00835-9 is OK
MISSING DOIs
- None
INVALID DOIs
- None
@editorialbot generate pdf
:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:
@SeriousHorncat can you provide a DOI for the release corresponding to this submission, e.g., on Zenodo?
DOI: 10.5281/zenodo.8348761 Is the DOI associated with out tagged 0.6.0 that was released on GitHub. @jmschrei
@editorialbot set 0.6.0 as version
Done! version is now 0.6.0
@editorialbot set 10.5281/zenodo.8348761 as archive
Done! archive is now 10.5281/zenodo.8348761
@editorialbot recommend-accept
Attempting dry run of processing paper acceptance...
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):
OK DOIs
- 10.1093/genetics/iyac022 is OK
- 10.1093/bioinformatics/btu613 is OK
- 10.1093/nar/gkx1098 is OK
- 10.1186/s13059-016-0974-4 is OK
- 10.1093/nar/gkaa1043 is OK
- 10.1093/nar/gkl993 is OK
- 10.1093/nar/gkac888 is OK
- 10.1093/nar/gkx1153 is OK
- 10.1093/nar/gku1205 is OK
- 10.1101/gr.176601 is OK
- 10.1038/nmeth0410-248 is OK
- 10.1093/nar/gkv1189 is OK
- 10.1186/s13073-021-00835-9 is OK
MISSING DOIs
- None
INVALID DOIs
- None
:wave: @openjournals/bcm-eics, this paper is ready to be accepted and published.
Check final proof :point_right::page_facing_up: Download article
If the paper PDF and the deposit XML files look good in https://github.com/openjournals/joss-papers/pull/4581, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept
@SeriousHorncat I am the AEiC on this track and here to help process final steps. I've checked your repository, the archive link, this review, and the paper. Most seems in order. Can you check the below final points please:
Alexander Moss
in the paper vs Alex Moss
for the archive. Can you make these the same?simul
is correct in the paper. @SeriousHorncat I am the AEiC on this track and here to help process final steps. I've checked your repository, the archive link, this review, and the paper. Most seems in order. Can you check the below final points please:
Alexander Moss
in the paper vs Alex Moss
for the archive. Can you make these the same?
simul
is correct in the paper.
New Version: 0.6.1 Updated Zenodo Archive for 0.6.1: 10.5281/zenodo.8380641
@editorialbot set 0.6.1 as version
Done! version is now 0.6.1
@editorialbot set 10.5281/zenodo.8380641 as archive
Done! archive is now 10.5281/zenodo.8380641
@SeriousHorncat thanks for implementing those changes. I think that addresses everything (and thanks for teaching me about the word simul, a new one for me). We will now proceed to accept this work in JOSS.
@editorialbot accept
Doing it live! Attempting automated processing of paper acceptance...
Submitting author: !--author-handle-->@serioushorncat<!--end-author-handle-- (Angelina Uno-Antonison) Repository: https://github.com/uab-cgds-worthey/rosalution Branch with paper.md (empty if default branch): Version: 0.6.1 Editor: !--editor-->@jmschrei<!--end-editor-- Reviewers: @suragnair, @JDRomano2 Archive: 10.5281/zenodo.8380641
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
@suragnair & @JDRomano2, 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 @jmschrei 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 @suragnair
📝 Checklist for @JDRomano2