openjournals / joss-reviews

Reviews for the Journal of Open Source Software
Creative Commons Zero v1.0 Universal
709 stars 38 forks source link

[REVIEW]: A MATLAB-based Instrument Control (MIC) package for fluorescence imaging #7275

Open editorialbot opened 2 hours ago

editorialbot commented 2 hours ago

Submitting author: !--author-handle-->@sajjad88<!--end-author-handle-- (Sajjad Khan) Repository: https://github.com/LidkeLab/matlab-instrument-control Branch with paper.md (empty if default branch): Version: v0.1.0 Editor: !--editor-->@adamltyson<!--end-editor-- Reviewers: @bencardoen, @raacampbell Archive: Pending

Status

status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/145f04b4b9a1d7dcb68f8e7d5bbe665b"><img src="https://joss.theoj.org/papers/145f04b4b9a1d7dcb68f8e7d5bbe665b/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/145f04b4b9a1d7dcb68f8e7d5bbe665b/status.svg)](https://joss.theoj.org/papers/145f04b4b9a1d7dcb68f8e7d5bbe665b)

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

@bencardoen & @raacampbell, 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:

@editorialbot generate my checklist

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @adamltyson 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 @raacampbell

📝 Checklist for @bencardoen

editorialbot commented 2 hours 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
editorialbot commented 2 hours ago
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.1364/OPEX.13.007052 is OK
- 10.1126/science.1127344 is OK
- 10.1038/nmeth929 is OK
- 10.1126/science.1137395 is OK
- 10.1021/acs.chemrev.6b00815 is OK
- 10.1016/j.bpj.2017.11.2912 is OK
- 10.21105/joss.05563 is OK
- 10.1371/journal.pone.0203291 is OK
- 10.1016/j.celrep.2023.113603 is OK
- 10.1038/s41467-022-34894-2 is OK
- 10.1002/0471142727.mb1420s92 is OK
- 10.5281/zenodo.4289803 is OK

🟡 SKIP DOIs

- None

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None
editorialbot commented 2 hours ago

Software report:

github.com/AlDanial/cloc v 1.90  T=0.31 s (1324.8 files/s, 185930.6 lines/s)
---------------------------------------------------------------------------------------
Language                             files          blank        comment           code
---------------------------------------------------------------------------------------
MATLAB                                 140           3471           6950          17329
XML                                     88              0              0          14990
C++                                     90           1049            856           3823
Markdown                                71            677              0           2530
C/C++ Header                             7            436            324           1599
Python                                   7            414            416           1574
Visual Studio Solution                   4              4              4           1006
TeX                                      1             16              0            180
YAML                                     1              6              7             18
Windows Module Definition                1              0              0              2
JSON                                     1              0              0              1
---------------------------------------------------------------------------------------
SUM:                                   411           6073           8557          43052
---------------------------------------------------------------------------------------

Commit count by author:

   580  dschodt
    91  Hanieh
    70  Sandeep
    59  sajjad88
    28  ellyse-taylor
    18  Michael Wester
    12  HMFarsibaf
    12  kiwibogo
    11  Keith Lidke
     8  Sandeep Pallikkuth
     8  TIRF
     7  Keith A. Lidke
     5  MohamadFazel
     3  kalidke
     2  Hanieh Mazloom Farsibaf
     2  Sajjad Khan
     2  Sheng Liu
     1  Ali
     1  Gert-Jan Bakker
     1  MJWester
editorialbot commented 2 hours ago

Paper file info:

📄 Wordcount for paper.md is 1135

✅ The paper includes a Statement of need section

editorialbot commented 2 hours ago

License info:

✅ License found: MIT License (Valid open source OSI approved license)

adamltyson commented 2 hours ago

@bencardoen, @raacampbell, 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:

@editorialbot generate my checklist

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 openjournals/joss-reviews#7275 so that a link is created to this thread (and I can keep an eye on what is happening). Please also feel free to comment and ask questions on this thread. In my experience, it is better to post comments/questions/suggestions as you come across them instead of waiting until you've reviewed the entire package.

Hardware submissions can be tricky to review, as not all reviewers will necessarily be able to review all functionality. I hope with three reviewers we can cover anything. However, if there are aspects of the submission you can't review, please let me know.

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 (@adamltyson) if you have any questions/concerns.

editorialbot commented 2 hours ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

raacampbell commented 2 hours ago

Review checklist for @raacampbell

Conflict of interest

Code of Conduct

General checks

Functionality

Documentation

Software paper

bencardoen commented 10 minutes ago

Review checklist for @bencardoen

Conflict of interest

Code of Conduct

General checks

Functionality

Documentation

Software paper