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]: FrESCO: Framework for Exploring Scalable Computational Oncology #5345

Closed
editorialbot opened this issue Apr 6, 2023 · 114 comments
Closed
Assignees
Labels
accepted published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review TeX Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials waitlisted Submissions in the JOSS backlog due to reduced service mode.

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented Apr 6, 2023

Submitting author: @aspannaus (Adam Spannaus)
Repository: https://github.com/DOE-NCI-MOSSAIC/FrESCO
Branch with paper.md (empty if default branch): JOSS
Version: v0.2.4
Editor: @jmschrei
Reviewers: @gabeerion, @anupamajha1
Archive: 10.5281/zenodo.8325993

Status

status

Status badge code:

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

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

@gabeerion & @SimonBiggs, 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 @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 @gabeerion

📝 Checklist for @anupamajha1

@editorialbot editorialbot added Python review TeX Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials waitlisted Submissions in the JOSS backlog due to reduced service mode. labels Apr 6, 2023
@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.49 s (57.6 files/s, 12989.1 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          18           1134           1133           3432
Markdown                         2             35              0            212
TeX                              2             41             36            162
YAML                             3             12             16            103
JSON                             3              0              0              3
-------------------------------------------------------------------------------
SUM:                            28           1222           1185           3912
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

@editorialbot
Copy link
Collaborator Author

Wordcount for paper.md is 842

@editorialbot
Copy link
Collaborator Author

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

@jmschrei
Copy link

jmschrei commented Apr 6, 2023

Howdy @gabeerion and @SimonBiggs!

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!

@SimonBiggs
Copy link

SimonBiggs commented Apr 6, 2023

Review checklist for @SimonBiggs

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://code.ornl.gov/mossaic/fresco?
  • 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 (@aspannaus) 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
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

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?

@editorialbot
Copy link
Collaborator Author

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

OK DOIs

- None

MISSING DOIs

- Errored finding suggestions for "Combating Label Noise in Deep Learning using Abste...", please try later
- 10.1371/journal.pone.0232840 may be a valid DOI for title: Using case-level context to classify cancer pathology reports
- Errored finding suggestions for "Automatic extraction of cancer registry reportable...", please try later
- Errored finding suggestions for "PyTorch: An Imperative Style, High-Performance Dee...", please try later
- Errored finding suggestions for "Pyhealth: A python library for health predictive m...", please try later
- 10.21105/joss.04943 may be a valid DOI for title: FuseMedML: a framework for accelerated discovery in machine learning based biomedicine
- Errored finding suggestions for "Med7: A transferable clinical natural language pro...", please try later
- Errored finding suggestions for "Clinical deployment environments: Five pillars of ...", please try later
- Errored finding suggestions for "ECP-Candle", please try later

INVALID DOIs

- https://doi.org/10.1016/j.artmed.2019.101726 is INVALID because of 'https://doi.org/' prefix

@gabeerion
Copy link

gabeerion commented Apr 9, 2023

Review checklist for @gabeerion

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://code.ornl.gov/mossaic/fresco?
  • 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 (@aspannaus) 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
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

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?

@jmschrei
Copy link

jmschrei commented May 3, 2023

Hi @SimonBiggs @gabeerion, how are the reviews coming?

@SimonBiggs
Copy link

Hi @jmschrei,

Not yet begun. I'm hoping to be able to earmark some time next week.

@gabeerion
Copy link

@jmschrei actively working on my review over last week and the coming one, thanks!

@SimonBiggs
Copy link

Hi @aspannaus,

I was hoping to be able to report an issue, however your issue list is locked down in such a way that I cannot create an account through the web interface.

Would it be possible for you to make a fork of this repository on GitHub where I can access the code without needing an ornl.gov account?

image

image

@aspannaus
Copy link

aspannaus commented May 10, 2023

Hi @SimonBiggs,

Let me take a look at the permissions. Someone outside of the organization was able to access the repo earlier this week, so I'm not sure what the issue is. I'll also look into the possibility of creating an open fork on Github. Thanks

I created a fork at https://code.ornl.gov/3t6/fresco that should be completely open. Check it out and let me know if you encounter any issues.

@SimonBiggs
Copy link

Hi @aspannaus,

I can confirm that cloning is now working. But I cannot raise an issue there either:

image

@aspannaus
Copy link

aspannaus commented May 11, 2023

Hi @SimonBiggs,

Apologies for the continued issue. We've got an internal ticket filed to sort this out; I'll post here once I have some resolution.

Update: we're going to move the repo over to GitHub, but this won't be instantaneous. I'll update here with the new url. Thanks

@aspannaus
Copy link

Hi @SimonBiggs, @gabeerion and @jmschrei,

We've moved the repo over to: https://github.com/DOE-NCI-MOSSAIC/FrESCO/tree/JOSS to address the issue noted above about not being able to create a git issue without registering.

Thanks again for your patience.

@jmschrei
Copy link

jmschrei commented May 20, 2023

@SimonBiggs @gabeerion how are the reviews coming?

@SimonBiggs
Copy link

@jmschrei, just waiting on the following before I continue:

We will finish internal testing with the reorganization to make the repo pip-installable and push the changes early next week.

DOE-NCI-MOSSAIC/FrESCO#1 (comment)

@aspannaus
Copy link

Just posting here for completeness, we updated the repository based on @gabeerion comments and suggestions.

https://github.com/DOE-NCI-MOSSAIC/FrESCO/issues/1#issuecomment-1561201091

@SimonBiggs
Copy link

Thanks @aspannaus,

I took a few small bites off the review this morning and have left two PRs on your repo for your review.

Cheers,
Simon

@aspannaus
Copy link

Hey @SimonBiggs,

Thanks for taking a look, we'll start working on the PRs.

@aspannaus
Copy link

Hi @SimonBiggs and @gabeerion,

Just checking in on the status of the review, if there's anything else you need from us.

Thanks!

@gabeerion
Copy link

gabeerion commented Jun 26, 2023 via email

@aspannaus
Copy link

@jmschrei, no worries. Glad to have it through and accepted. Thanks again for all the assistance!

@Kevin-Mattheus-Moerman
Copy link
Member

Kevin-Mattheus-Moerman commented Sep 4, 2023

@aspannaus I am the AEiC for this track and here to help with final steps. Apologies for the delay, I was out of the office for a bit.

I have checked your repository, the paper, this review, and the archive, and have a few points the need your attention:

  • I have just looked at archive link provided: https://doi.org/10.11578/dc.20230227.2. That link does not seem to archive the actual software. Can you clarify if you've archived the software (full content of your software repository)? This is what is required for JOSS.
  • In your paper's affiliations, please spell out USA as United States of America
  • It looks like you can add a DOI (https://doi.org/10.48550/arXiv.2211.02701) for the paper "MONAI: An open-source framework for deep learning in healthcare"
  • It looks like you can add a DOI (https://doi.org/10.48550/arXiv.2204.06604) for the paper "Ehrkit: A python natural language processing toolkit for electronic health record texts."
  • It looks like you can add a DOI (https://doi.org/10.48550/arXiv.2101.04209) for the paper "PyHealth: A Python Library for Health Predictive Models."

@aspannaus
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@aspannaus
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@Kevin-Mattheus-Moerman
Copy link
Member

@aspannaus I see the DOIs seem fixed. However, are you also able to address the issue with the archiving link? ☝️

@aspannaus
Copy link

Hi @Kevin-Mattheus-Moerman, we are working on getting Zenodo connected to the repo and expect to have that completed by tomorrow. Thanks

@aspannaus
Copy link

Hi @Kevin-Mattheus-Moerman,

The archive link is here: https://zenodo.org/record/8325994. Let us know if there's anything else you need from us. Thanks!

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot set 10.5281/zenodo.8325993 as archive

@editorialbot
Copy link
Collaborator Author

Done! archive is now 10.5281/zenodo.8325993

@Kevin-Mattheus-Moerman
Copy link
Member

Kevin-Mattheus-Moerman commented Sep 10, 2023

Post-Review Checklist for Editor and Authors

Additional Author Tasks After Review is Complete

  • Double check authors and affiliations (including ORCIDs)
  • Make a release of the software with the latest changes from the review and post the version number here. This is the version that will be used in the JOSS paper.
  • Archive the release on Zenodo/figshare/etc and post the DOI here.
  • Make sure that the title and author list (including ORCIDs) in the archive match those in the JOSS paper.
  • Make sure that the license listed for the archive is the same as the software license.

Editor Tasks Prior to Acceptance

  • Read the text of the paper and offer comments/corrections (as either a list or a PR)
  • Check the references in the paper for corrections (e.g. capitalization)
  • Check that the archive title, author list, version tag, and the license are correct
  • Set archive DOI with @editorialbot set <DOI here> as archive
  • Set version with @editorialbot set <version here> as version
  • Double check rendering of paper with @editorialbot generate pdf
  • Specifically check the references with @editorialbot check references and ask author(s) to update as needed
  • Recommend acceptance with @editorialbot recommend-accept

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot set v0.2.4 as version

@editorialbot
Copy link
Collaborator Author

Done! version is now v0.2.4

@Kevin-Mattheus-Moerman
Copy link
Member

@aspannaus thanks for posting that archive link. The above checkbox set ☝️ shows some remaining action items. In particular the authors listed, the title, and the license listed for the archive need to be amended. You can do this manually.

@aspannaus
Copy link

Hi @Kevin-Mattheus-Moerman , we've taken care of the above items. Let us know if you need anything else. Thanks again

@Kevin-Mattheus-Moerman
Copy link
Member

Kevin-Mattheus-Moerman commented Sep 11, 2023

@aspannaus nearly there. The archive title should match the paper title FrESCO: Framework for Exploring Scalable Computational Oncology, so please amend accordingly.

@aspannaus
Copy link

@Kevin-Mattheus-Moerman , thanks for catching that. I've amended the software archive title to match the manuscript title.

@Kevin-Mattheus-Moerman
Copy link
Member

@aspannaus thanks. All looks good now.

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot accept

@editorialbot
Copy link
Collaborator Author

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

@editorialbot
Copy link
Collaborator Author

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

cff-version: "1.2.0"
authors:
- family-names: Spannaus
  given-names: Adam
  orcid: "https://orcid.org/0000-0002-2521-3657"
- family-names: Gounley
  given-names: John
- family-names: Shekar
  given-names: Mayanka Chandra
- family-names: Fox
  given-names: Zachary R.
- family-names: Mohd-Yusof
  given-names: Jamaludin
- family-names: Schaefferkoetter
  given-names: Noah
- family-names: Hanson
  given-names: Heidi A.
contact:
- family-names: Spannaus
  given-names: Adam
  orcid: "https://orcid.org/0000-0002-2521-3657"
doi: 10.5281/zenodo.8325993
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Spannaus
    given-names: Adam
    orcid: "https://orcid.org/0000-0002-2521-3657"
  - family-names: Gounley
    given-names: John
  - family-names: Shekar
    given-names: Mayanka Chandra
  - family-names: Fox
    given-names: Zachary R.
  - family-names: Mohd-Yusof
    given-names: Jamaludin
  - family-names: Schaefferkoetter
    given-names: Noah
  - family-names: Hanson
    given-names: Heidi A.
  date-published: 2023-09-11
  doi: 10.21105/joss.05345
  issn: 2475-9066
  issue: 89
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 5345
  title: "FrESCO: Framework for Exploring Scalable Computational
    Oncology"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.05345"
  volume: 8
title: "FrESCO: Framework for Exploring Scalable Computational Oncology"

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.

Find more information on .cff files here and here.

@editorialbot
Copy link
Collaborator Author

🐘🐘🐘 👉 Toot 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.05345 joss-papers#4546
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.05345
  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 Sep 11, 2023
@aspannaus
Copy link

Thanks to @Kevin-Mattheus-Moerman and @jmschrei for editorial assistance and @gabeerion @anupamajha1 for the constructive feedback and reviews.

@Kevin-Mattheus-Moerman
Copy link
Member

@aspannaus congratulations on this publication!

Thanks for editing @jmschrei !

And a special thanks to the reviewers: @gabeerion, @anupamajha1 !!

@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.05345/status.svg)](https://doi.org/10.21105/joss.05345)

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

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

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review TeX Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials waitlisted Submissions in the JOSS backlog due to reduced service mode.
Projects
None yet
Development

No branches or pull requests

7 participants