Closed editorialbot closed 9 months 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.52 s (862.9 files/s, 243710.8 lines/s)
-------------------------------------------------------------------------------
Language files blank comment code
-------------------------------------------------------------------------------
HTML 200 9160 600 57612
Python 154 5336 4225 18475
JavaScript 16 4511 4394 16122
SVG 1 0 0 2671
reStructuredText 67 764 646 1000
CSS 4 187 35 756
Markdown 6 167 0 650
TeX 1 16 0 204
DOS Batch 1 23 1 166
make 1 24 5 124
Bourne Shell 1 8 3 34
YAML 1 1 4 21
-------------------------------------------------------------------------------
SUM: 453 20197 9913 97835
-------------------------------------------------------------------------------
gitinspector failed to run statistical information for the repository
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):
OK DOIs
- 10.1038/s41586-020-2649-2 is OK
- 10.1038/s41592-019-0686-2 is OK
- 10.25080/majora-7b98e3ed-013 is OK
- 10.1109/MCSE.2007.55 is OK
- 10.1109/mcse.2011.35 is OK
- 10.7567/APEX.11.092601 is OK
- 10.1021/acs.nanolett.0c01006 is OK
- 10.1063/4.0000059 is OK
- 10.1021/acs.nanolett.2c03938 is OK
- 10.1126/sciadv.abg1322 is OK
- 10.1063/5.0106517 is OK
- 10.1093/jmicro/dfad021 is OK
- 10.1039/D2FD00062H is OK
MISSING DOIs
- None
INVALID DOIs
- None
Wordcount for paper.md
is 1294
:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:
👋 Hi @kuadrat, @ziatdinovmax, and @pr4deepr, and thank you again for agreeing to review this submission for lys !
The review will take place in this issue, and you can generate your individual reviewer checklists by asking editorialbot directly with @editorialbot generate my checklist
.
In working through the checklist, you're likely to have specific feedback on lys. Whenever possible, please open relevant issues on the linked software repository (and cross-link them with this issue) rather than discussing them here. This helps to make sure that feedback is translated into actionable items to improve the software !
If you aren't sure how to get started, please see the Reviewing for JOSS guide -- and, of course, feel free to ping me with any questions !
Regarding "Contribution and authorship", I'm not sure how to judge this as there seems to be multiple accounts that have contributed to the code and I cannot ascertain who they belong to. Commit history.
There are multiple acccounts: @LabviewShare, @lys-devel which is the current account.
@emdupre, how do you suggest I proceed? @lys-devel
@pr4deepr , @emdupre I'm sorry for confusing commit history. "LabviewShare" is my private account. Since lys have been private repository in our lab, I used it until very recently. If it is needed, I will comment here from "LabviewShare" account for verification.
Thanks @lys-devel . Perhaps that should be enough for now, unless anyone has other concerns..
👋 Hi @ziatdinovmax, I noticed that you had not yet generated your reviewer checklist, so I wanted to check-in and make sure you weren't encountering any issues in doing so. Please let me know, and thank you again for agreeing to review lys !
@editorialbot generate pdf
:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:
Hi @emdupre @kuadrat
I made 2 issues here:
https://github.com/lys-devel/lys/issues/14
https://github.com/lys-devel/lys/issues/13
Just wanted to make sure these are still in the scope of the review?
Cheers Pradeep
Just wanted to make sure these are still in the scope of the review?
Thanks for checking in on this, @pr4deepr ! I see https://github.com/lys-devel/lys/issues/13 and https://github.com/lys-devel/lys/issues/14 as in-scope for the review, targeting A statement of need:
/ State of the field:
and Example usage:
, respectively. If I've misunderstood your concern, though, please let me know !
And of course, if you have other questions, please don't hesitate to ask !
@editorialbot generate pdf
:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:
👋 HI everyone, and happy Friday !
@ziatdinovmax I just wanted to follow-up and confirm if you're having any difficulties in working through your reviewer checklist, as I noticed you haven't yet been able to assess the "functionality", "documentation" or "software paper" categories -- which I know are more involved !
If you have any concerns, please let me know. And thank you again for agreeing to review lys !
@lys-devel A minor suggestion re: automated tests. It is typically helpful to display the test coverage using e.g. codecov which is free. It also signals the maturity of the package and of maintenance effort which helps attract more users.
For the statement of need, I feel it needs a further justification of why research scientists can't just rely on the already exisiting domain-specific software tools for data analysis and visualization.
@lys-devel - my apologies if I missed this in the documentation, but I think currently it doesn't account for a pretty common situation when multi-dimensional data is in a proprietary format, and one needs to use some form of a translator to convert it to lys-readable format. This seems like the first and most important step without which one cannot use this package. I suggest mentioning it and perhaps providing links to some common translator packages.
@ziatdinovmax Thank you for your fruitful comments. For clarity, I opened the issues regarding the above points in the repository. I will respond all issues in a few days.
@editorialbot generate pdf
:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:
👋 Hi everyone, just a small note that I will be out-of-office 30 October - 10 November. I will answer any comments or questions as soon as I'm back, though, so please don't hesitate to ping this thread.
@lys-devel - thank you for addressing my questions/concerns! @emdupre - all my concerns have been now addressed and I'm happy to recommend this paper for publication.
@lys-devel @emdupre Most of the concerns have been addressed. I've also tried going through most of the doc successfully. I really like the CUI/GUI architecture and the ability to run and use our own code quite flexibly.
I don't want to delay the review any longer as the software functions well. Although, I think the paper can benefit from some proofreading. @emdupre, is this something JOSS can assist with?
Examples of typo and grammar or sentence structure:
Other:
Cheers Pradeep
@editorialbot generate pdf
:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:
@pr4deepr , Thank you for the comments. I opened the issues in the repository because reply was long. In addition to the points above, I will proofread the manuscript with my colleagues before @emdupre comes back.
@editorialbot generate pdf
:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:
Hi everyone,
I'm back in office ! Thank you for your patience.
@pr4deepr and @ziatdinovmax, thank you for your confirmation of your reviews ! @pr4deepr, I noted that https://github.com/lys-devel/lys/issues/20 was closed following your comments, so I believe these are now addressed. Please let me know, though, if this is not the case.
Otherwise, it looks like all three reviewer checklists are now completed ! @kuadrat could you please confirm that you are happy with this submission for lys
in its current form ? I noted that you still have two open issues, but it looks like you've marked these as "not review-critical," so I wanted to confirm.
Once I have final confirmation, I'll perform a few additional editorial checks to help in processing this submission 🚀
@emdupre , yup, happy with the manuscript.
Welcome back, @emdupre!
Indeed, I also think that the manuscript and the software fulfill the conditions for publication in JOSS. The remaining open issues are not review critical.
Thank you both, @pr4deepr and @kuadrat !
I'll now perform a few additional editorial checks.
@editorialbot generate pdf
:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:
@editorialbot check references
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):
OK DOIs
- 10.1038/s41586-020-2649-2 is OK
- 10.1038/s41592-019-0686-2 is OK
- 10.25080/majora-7b98e3ed-013 is OK
- 10.1109/MCSE.2007.55 is OK
- 10.1109/mcse.2011.35 is OK
- 10.7567/APEX.11.092601 is OK
- 10.1021/acs.nanolett.0c01006 is OK
- 10.1063/4.0000059 is OK
- 10.1021/acs.nanolett.2c03938 is OK
- 10.1126/sciadv.abg1322 is OK
- 10.1063/5.0106517 is OK
- 10.1093/jmicro/dfad021 is OK
- 10.1039/D2FD00062H is OK
- 10.21105/joss.02969 is OK
- 10.1017/S1431927622006328 is OK
MISSING DOIs
- None
INVALID DOIs
- None
Thank you for your patience, @lys-devel ! I've reviewed and am also happy with the software 🎉 I have a few editorial requests on the software paper itself.
Major comments
The summary currently points to several specific software packages and kinds of computing environments. While this is very useful for regular developers, it may be less familiar to non-specialist audiences. The JOSS guidelines for the Summary ask that this section focus on:
describing the high-level functionality and purpose of the software for a diverse, non-specialist audience.
Could you thus please re-orient the Summary towards this non-specialist audience ? I would suggest to use similar language to e.g., L20-22 and L58-64.
napari and data-slicer are first mentioned on L37 as "sophisticated data analysis/visualization tools" ; however, a more direct comparison of lys with these tools is not provided until L115. It would be useful to have this discussion moved into the Statement of Need, to make the current state of the field clearer to the reader. Per the JOSS guidelines, the Statement of Need:
clearly illustrates the research purpose of the software and places it in the context of related work.
If desired, discussion of L47 - L57 could be moved into the Overview to focus each section's content.
Minor comments
MultiCut
interface referred to throughout the text ?@editorialbot generate pdf
:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:
Thank you for you editorial effort, @emdupre. I also appreciate all reviewers for their kind comments. I modified the manuscript following your advice.
Could you thus please re-orient the Summary towards this non-specialist audience ?
Thank you for the comment. I modified the Summary towards non-specialist audience in Line 6-20.
Figure 1. Can you please describe each of the figure panels directly in the figure caption, rather than in-text ? Figure 2. Similarly, can you please expand the figure caption ? I understand that it is not entirely possible to move the description into the caption given its length.
I modified the figure captions of Fig. 1 and 2.
napari and data-slicer are first mentioned on L37 as "sophisticated data analysis/visualization tools" ; however, a more direct comparison of lys with these tools is not provided until L115. It would be useful to have this discussion moved into the Statement of Need, to make the current state of the field clearer to the reader
Thank you for the important comment. I added the sentences that describe the current state of the field in Line 46-54. I did not change the discussion in Line 117-133 because I consider the comparison between other software is also needed after describing what is lys.
I could not find example of how to add RRID in JOSSS website, so I added RRID directly in Line 26. Could you confirm this style of RRID is suitable for JOSS?
Figure 1. Could you please explicitly note that this GUI is the MultiCut interface referred to throughout the text ?
Figure 1 is not the screenshot of MultiCut (there is no screenshot of MultiCut in the manuscript). So I did not modify the manuscript regarding this point.
I hope the manuscript has been modified suitably for JOSS, Thank you.
Thank you, @lys-devel ! I appreciate you making these changes.
I could not find example of how to add RRID in JOSSS website, so I added RRID directly in Line 26. Could you confirm this style of RRID is suitable for JOSS?
Apologies for not providing this ; if you could please remove the space between RRID:
and the SCR identifier, these would be in the correct format. Thus, MATLAB would be RRID:SCR_001622
.
The only remaining concern I see is that the software are stylized as Igor Pro
and Matlab
on L120. Could you please correct the capitalization there as well ?
After making these changes, could you then please:
@editorialbot generate pdf
:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:
Submitting author: !--author-handle-->@lys-devel<!--end-author-handle-- (Asuka Nakamura) Repository: https://github.com/lys-devel/lys Branch with paper.md (empty if default branch): review Version: v0.3.3_zenodo Editor: !--editor-->@emdupre<!--end-editor-- Reviewers: @kuadrat, @ziatdinovmax, @pr4deepr Archive: 10.5281/zenodo.10241638
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
@kuadrat & @ziatdinovmax & @pr4deepr, 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 @emdupre 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 @kuadrat
📝 Checklist for @pr4deepr
📝 Checklist for @ziatdinovmax