Skip to content
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]: PCRedux: A Quantitative PCR Machine Learning Toolkit #4407

Closed
editorialbot opened this issue May 20, 2022 · 72 comments
Closed

[REVIEW]: PCRedux: A Quantitative PCR Machine Learning Toolkit #4407

editorialbot opened this issue May 20, 2022 · 72 comments
Assignees
Labels
accepted CSS JavaScript published Papers published in JOSS R recommend-accept Papers recommended for acceptance in JOSS. review

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented May 20, 2022

Submitting author: @devSJR (Stefan Rödiger)
Repository: https://github.com/PCRuniversum/PCRedux
Branch with paper.md (empty if default branch):
Version: 1.1-2
Editor: @csoneson
Reviewers: @jaybee84, @markziemann
Archive: 10.5281/zenodo.7009124

Status

status

Status badge code:

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

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

@jaybee84 & @markziemann, 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 @csoneson 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 @jaybee84

📝 Checklist for @markziemann

@editorialbot
Copy link
Collaborator Author

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
Copy link
Collaborator Author

Software report:

github.com/AlDanial/cloc v 1.88  T=0.08 s (1038.8 files/s, 170467.2 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
HTML                            23           1123            261           3692
CSS                              3            360             73           1961
TeX                              2            144             10           1890
R                               41            399           1086           1659
Markdown                         4             77              0            471
JavaScript                       5             59             27            287
SVG                              2              0              1            122
YAML                             3             11              0             52
Rmd                              1              1             18              0
-------------------------------------------------------------------------------
SUM:                            84           2174           1476          10134
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

@editorialbot
Copy link
Collaborator Author

Wordcount for paper.md is 2249

@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.3233/JCB-15025 is OK
- 10.1373/clinchem.2014.230656 is OK
- 10.1093/bioinformatics/btx528 is OK
- 10.1093/bioinformatics/btv205 is OK
- 10.1016/j.bdq.2018.08.001 is OK
- 10.1038/srep38951 is OK
- 10.1038/s41598-021-00827-0 is OK
- 10.3390/life11111163 is OK
- 10.1198/106186007X178663 is OK
- 10.1186/gb-2004-5-10-r80 is OK
- 10.1186/1471-2105-9-221 is OK
- 10.1093/bioinformatics/btn227 is OK
- 10.1016/j.bdq.2014.08.002 is OK
- 10.1016/j.ymeth.2009.12.006 is OK
- 10.18637/jss.v023.i03 is OK
- 10.18637/jss.v062.i07 is OK
- 10.18637/jss.v032.i03 is OK
- 10.1016/j.ymeth.2012.08.011 is OK
- 10.1016/j.bdq.2015.07.001 is OK
- 10.1261/rna.059063.116 is OK
- 10.1016/j.bdq.2017.11.002 is OK
- 10.1016/S0304-3940(02)01423-4 is OK
- 10.1093/clinchem/hvab052 is OK
- 10.1016/j.tibtech.2018.12.002 is OK
- 10.1186/1471-2105-15-138 is OK
- 10.1093/gigascience/giy077 is OK
- 10.1111/anzs.12200 is OK
- 10.3390/life11111163 is OK
- 10.18637/jss.v049.i09 is OK

MISSING DOIs

- 10.32614/rj-2011-002 may be a valid DOI for title: testthat: Get Started with Testing
- 10.32614/rj-2014-015 may be a valid DOI for title: Archiving Reproducible Research with R and Dataverse

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@csoneson
Copy link
Member

👋🏼 @devSJR, @jaybee84, @markziemann - this is the review thread for the submission. All of our communications will happen here from now on.

Please check the post at the top of the issue for instructions on how to generate your own review checklist. As you go over the submission, please check any items that you feel have been satisfied. There are also 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 directly in the software repository. If you do so, please mention this thread so that a link is created (and I can keep an eye on what is happening). Please also feel free to comment and ask questions in this thread. It is often easier to post comments/questions/suggestions as you come across them instead of waiting until you've reviewed the entire package.

Please feel free to ping me (@csoneson) if you have any questions or concerns. Thanks!

@devSJR
Copy link

devSJR commented May 20, 2022

@csoneson, editorialbot found two MISSING DOIs

  • 10.32614/rj-2011-002 may be a valid DOI for title: testthat: Get Started with Testing
  • 10.32614/rj-2014-015 may be a valid DOI for title: Archiving Reproducible Research with R and Dataverse

The bot is right. We cited the packages without the DOIs of the articles of the R Journal. We will correct this accordingly.

@devSJR
Copy link

devSJR commented May 20, 2022

@editorialbot generate pdf

@devSJR
Copy link

devSJR commented May 20, 2022

@csoneson, editorialbot found two MISSING DOIs

* 10.32614/rj-2011-002 may be a valid DOI for title: testthat: Get Started with Testing

* 10.32614/rj-2014-015 may be a valid DOI for title: Archiving Reproducible Research with R and Dataverse

The bot is right. We cited the packages without the DOIs of the articles of the R Journal. We will correct this accordingly.

Done

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@devSJR
Copy link

devSJR commented May 20, 2022

@csoneson, I have found a duplication of a citation (R Core Team). This is fixed now.
I will not touch the paper anymore unless you request me to do so.

@devSJR
Copy link

devSJR commented May 20, 2022

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@csoneson
Copy link
Member

csoneson commented Jun 5, 2022

👋🏻 @jaybee84, @markziemann - just wanted to check in on your reviews. Note that you each need to generate your own review checklist (see instructions above). Let me know if you have any questions!

@jaybee84
Copy link

jaybee84 commented Jun 6, 2022

Review checklist for @jaybee84

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the https://github.com/PCRuniversum/PCRedux?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@devSJR) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

@devSJR
Copy link

devSJR commented Jun 7, 2022

@csoneson I noticed in the checklist under General checks the entry "License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?"

So far the LICENSE (MIT) was stated in the DESCRIPTION file. However, there was no LICENSE text. I have added the text from https://opensource.org/licenses/MIT

@markziemann
Copy link

markziemann commented Jun 7, 2022

Review checklist for @markziemann

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the https://github.com/PCRuniversum/PCRedux?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@devSJR) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

@markziemann
Copy link

markziemann commented Jun 7, 2022

👋🏻 @jaybee84, @markziemann - just wanted to check in on your reviews. Note that you each need to generate your own review checklist (see instructions above). Let me know if you have any questions!

@csoneson Checklist is complete. All good from my end. Great piece of work.

@csoneson
Copy link
Member

csoneson commented Jun 7, 2022

Thank you @markziemann 🙂

@csoneson
Copy link
Member

👋🏻 @jaybee84 - could you update us on the status of your review? Thanks!

@jaybee84
Copy link

@csoneson Apologies for the delayed response due to conference related travel. I should be able to complete this review by the end of the week. Thanks for your patience.

@csoneson
Copy link
Member

I should be able to complete this review by the end of the week. Thanks for your patience.

@jaybee84 - just a gentle reminder of your review here. Thanks!

@devSJR
Copy link

devSJR commented Aug 3, 2022

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@devSJR
Copy link

devSJR commented Aug 19, 2022

Thanks @devSJR! I went through the paper again and I think this looks good - I sent another small PR with a couple of minor fixes. Regarding the attachment, I would suggest that you upload the current vignette to e.g. Zenodo or FigShare, and refer to that (you would get a DOI).

Once these things are sorted, the next steps are as follows:

* [ ]  Make a tagged release of the software, and list the version tag of the archived version here.

* [ ]  Archive the reviewed software in Zenodo or a similar service

* [ ]  Check that the archival deposit (e.g., in Zenodo) has the correct metadata. In particular, the title and author list should be identical to those of the paper. You can also add the authors' ORCID.

* [ ]  Please list the DOI of the archived version here.

I can then move forward with accepting the submission.

@csoneson, finally here are the missing bits.

version tag of the archived version: 1.1-2
DOI of the archived version 10.5281/zenodo.7009124
https://doi.org/10.5281/zenodo.7009124

@csoneson
Copy link
Member

@editorialbot check references

@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.5281/zenodo.6957714 is OK
- 10.32614/RJ-2015-011 is OK
- 10.32614/RJ-2013-024 is OK
- 10.3233/JCB-15025 is OK
- 10.1373/clinchem.2014.230656 is OK
- 10.1093/bioinformatics/btx528 is OK
- 10.1093/bioinformatics/btv205 is OK
- 10.1016/j.bdq.2018.08.001 is OK
- 10.1038/srep38951 is OK
- 10.1038/s41598-021-00827-0 is OK
- 10.3390/life11111163 is OK
- 10.1198/106186007X178663 is OK
- 10.1186/gb-2004-5-10-r80 is OK
- 10.1186/1471-2105-9-221 is OK
- 10.1093/bioinformatics/btn227 is OK
- 10.1016/j.bdq.2014.08.002 is OK
- 10.1016/j.ymeth.2009.12.006 is OK
- 10.32614/rj-2011-002 is OK
- 10.18637/jss.v023.i03 is OK
- 10.18637/jss.v062.i07 is OK
- 10.18637/jss.v032.i03 is OK
- 10.1016/j.ymeth.2012.08.011 is OK
- 10.1016/j.bdq.2015.07.001 is OK
- 10.1261/rna.059063.116 is OK
- 10.1016/j.bdq.2017.11.002 is OK
- 10.1016/S0304-3940(02)01423-4 is OK
- 10.1093/clinchem/hvab052 is OK
- 10.1016/j.tibtech.2018.12.002 is OK
- 10.1186/1471-2105-15-138 is OK
- 10.32614/rj-2014-015 is OK
- 10.1093/gigascience/giy077 is OK
- 10.1111/anzs.12200 is OK
- 10.3390/life11111163 is OK
- 10.18637/jss.v049.i09 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@csoneson
Copy link
Member

@editorialbot set 10.5281/zenodo.7009124 as archive

@editorialbot
Copy link
Collaborator Author

Done! Archive is now 10.5281/zenodo.7009124

@csoneson
Copy link
Member

@editorialbot set 1.1-2 as version

@editorialbot
Copy link
Collaborator Author

Done! version is now 1.1-2

@csoneson
Copy link
Member

@devSJR Thanks! I'll hand over now to an associate EiC for the final steps. Thanks for submitting to JOSS!

@csoneson
Copy link
Member

@editorialbot recommend-accept

@editorialbot
Copy link
Collaborator Author

Attempting dry run of processing paper acceptance...

@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.5281/zenodo.6957714 is OK
- 10.32614/RJ-2015-011 is OK
- 10.32614/RJ-2013-024 is OK
- 10.3233/JCB-15025 is OK
- 10.1373/clinchem.2014.230656 is OK
- 10.1093/bioinformatics/btx528 is OK
- 10.1093/bioinformatics/btv205 is OK
- 10.1016/j.bdq.2018.08.001 is OK
- 10.1038/srep38951 is OK
- 10.1038/s41598-021-00827-0 is OK
- 10.3390/life11111163 is OK
- 10.1198/106186007X178663 is OK
- 10.1186/gb-2004-5-10-r80 is OK
- 10.1186/1471-2105-9-221 is OK
- 10.1093/bioinformatics/btn227 is OK
- 10.1016/j.bdq.2014.08.002 is OK
- 10.1016/j.ymeth.2009.12.006 is OK
- 10.32614/rj-2011-002 is OK
- 10.18637/jss.v023.i03 is OK
- 10.18637/jss.v062.i07 is OK
- 10.18637/jss.v032.i03 is OK
- 10.1016/j.ymeth.2012.08.011 is OK
- 10.1016/j.bdq.2015.07.001 is OK
- 10.1261/rna.059063.116 is OK
- 10.1016/j.bdq.2017.11.002 is OK
- 10.1016/S0304-3940(02)01423-4 is OK
- 10.1093/clinchem/hvab052 is OK
- 10.1016/j.tibtech.2018.12.002 is OK
- 10.1186/1471-2105-15-138 is OK
- 10.32614/rj-2014-015 is OK
- 10.1093/gigascience/giy077 is OK
- 10.1111/anzs.12200 is OK
- 10.3390/life11111163 is OK
- 10.18637/jss.v049.i09 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

👋 @openjournals/joss-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#3454, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

@editorialbot editorialbot added the recommend-accept Papers recommended for acceptance in JOSS. label Aug 21, 2022
@arfon
Copy link
Member

arfon commented Aug 21, 2022

@editorialbot accept

@editorialbot
Copy link
Collaborator Author

Doing it live! Attempting automated processing of paper acceptance...

@editorialbot
Copy link
Collaborator Author

🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦

@editorialbot
Copy link
Collaborator Author

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨

Here's what you must now do:

  1. Check final PDF and Crossref metadata that was deposited 👉 Creating pull request for 10.21105.joss.04407 joss-papers#3455
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.04407
  3. If everything looks good, then close this review issue.
  4. Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? Notify your editorial technical team...

@editorialbot editorialbot added accepted published Papers published in JOSS labels Aug 21, 2022
@arfon
Copy link
Member

arfon commented Aug 21, 2022

@jaybee84, @markziemann – many thanks for your reviews here and to @csoneson for editing this submission! JOSS relies upon the volunteer effort of people like you and we simply wouldn't be able to do this without you ✨

@devSJR – your paper is now accepted and published in JOSS ⚡🚀💥

@arfon arfon closed this as completed Aug 21, 2022
@editorialbot
Copy link
Collaborator Author

🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉

If you would like to include a link to your paper from your README use the following code snippets:

Markdown:
[![DOI](https://joss.theoj.org/papers/10.21105/joss.04407/status.svg)](https://doi.org/10.21105/joss.04407)

HTML:
<a style="border-width:0" href="https://doi.org/10.21105/joss.04407">
  <img src="https://joss.theoj.org/papers/10.21105/joss.04407/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: https://joss.theoj.org/papers/10.21105/joss.04407/status.svg
   :target: https://doi.org/10.21105/joss.04407

This is how it will look in your documentation:

DOI

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:

@devSJR
Copy link

devSJR commented Aug 21, 2022

@arfon @jaybee84 @markziemann @csoneson

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted CSS JavaScript published Papers published in JOSS R recommend-accept Papers recommended for acceptance in JOSS. review
Projects
None yet
Development

No branches or pull requests

6 participants