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]: survxai: an R package for model agnostic explanations of survival models #961

Closed
36 tasks done
whedon opened this issue Sep 17, 2018 · 35 comments
Closed
36 tasks done
Assignees
Labels
accepted published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. review

Comments

@whedon
Copy link

whedon commented Sep 17, 2018

Submitting author: @AleksandraDabrowska (Aleksandra Grudziąż)
Repository: https://github.com/MI2DataLab/survxai
Version: 0.2.0
Editor: @yochannah
Reviewer: @hiendn, @dirmeier
Archive: 10.5281/zenodo.1477857

Status

status

Status badge code:

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

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) 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

@hiendn & @dirmeier, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:

  1. Make sure you're logged in to your GitHub account
  2. Be sure to accept the invite at this URL: https://github.com/openjournals/joss-reviews/invitations

The reviewer guidelines are available here: https://joss.theoj.org/about#reviewer_guidelines. Any questions/concerns please let @yochannah know.

Please try and complete your review in the next two weeks

Review checklist for @hiendn

Conflict of interest

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the repository url?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Version: Does the release version given match the GitHub release (0.2.0)?
  • Authorship: Has the submitting author (@AleksandraDabrowska) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

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 function 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

  • Authors: Does the paper.md file include a list of authors with their affiliations?
  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?

Review checklist for @dirmeier

Conflict of interest

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the repository url?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Version: Does the release version given match the GitHub release (0.2.0)?
  • Authorship: Has the submitting author (@AleksandraDabrowska) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

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 function 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

  • Authors: Does the paper.md file include a list of authors with their affiliations?
  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?
@whedon
Copy link
Author

whedon commented Sep 17, 2018

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @hiendn, it looks like you're currently assigned as the reviewer for this paper 🎉.

⭐ Important ⭐

If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/openjournals/joss-reviews) repository. As a reviewer, you're probably currently watching this repository which means for GitHub's default behaviour you will receive notifications (emails) for all reviews 😿

To fix this do the following two things:

  1. Set yourself as 'Not watching' https://github.com/openjournals/joss-reviews:

watching

  1. You may also like to change your default settings for this watching repositories in your GitHub profile here: https://github.com/settings/notifications

notifications

For a list of things I can do to help you, just type:

@whedon commands

@whedon
Copy link
Author

whedon commented Sep 17, 2018

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Sep 17, 2018

@hiendn
Copy link

hiendn commented Sep 20, 2018

Hi @AleksandraDabrowska, I am one of your reviewers! My comments and suggestions will be posted on the issues page of your repository.

@yochannah
Copy link

yochannah commented Oct 8, 2018

Quick status check - looking at the original repo, issues 18 to 21 need to be addressed before we can take this one forward, right?

@dirmeier
Copy link

dirmeier commented Oct 8, 2018

Yeah, exactly. From my side these two and 20. All of them are minor changes.

@hiendn
Copy link

hiendn commented Oct 8, 2018

@yochannah that's correct, resolving 22 would be good as well, if possible.

@yochannah
Copy link

👋 @AleksandraDabrowska - any progress or ETA for the ticket revisions?

@dirmeier
Copy link

Hey @AleksandraDabrowska - could you rebuild the pdf once you are finished with the reviews? Then I can close the respective issues in your repository.

@AleksandraDabrowska
Copy link

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Oct 30, 2018

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Oct 30, 2018

@AleksandraDabrowska
Copy link

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Oct 30, 2018

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Oct 30, 2018

@hiendn
Copy link

hiendn commented Nov 2, 2018

I am now entirely happy with the with article.

@dirmeier
Copy link

dirmeier commented Nov 2, 2018

Likewise. A very nice package, too! :)

@AleksandraDabrowska
Copy link

@hiendn @dirmeier Thank you very much for reviewing and for your kind words! :)
Should we now issue a DOI for our archive, as it is written in "The review process" section (https://joss.readthedocs.io/en/latest/submitting.html?fbclid=IwAR04SV6oxRM9B3mPL8NXhMhzToU_c3PwwcuiATwttKWaty2rEm8X8aZ19TM)?

@yochannah
Copy link

@AleksandraDabrowska Looking good! Before generating the archive, though, there is one issue with the manuscript I'd like to fix. Figures 3 and 4 are interspersed with the references in the most recent proof, but I'm reasonably sure they should be up in the main paper text. Can you fix this? Once this is fixed, please do generate an archive and share the URL in this thread!! 🎉

@AleksandraDabrowska
Copy link

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Nov 5, 2018

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Nov 5, 2018

👉 Check article proof 📄 👈

@AleksandraDabrowska
Copy link

@yochannah
Copy link

The figures look better! Thanks @AleksandraDabrowska

@yochannah
Copy link

@whedon set http://doi.org/10.5281/zenodo.1477857 as archive

@whedon
Copy link
Author

whedon commented Nov 5, 2018

OK. 10.5281/zenodo.1477857 is the archive.

@yochannah
Copy link

@arfon I think we're ready to accept this one!

@arfon
Copy link
Member

arfon commented Nov 6, 2018

@whedon accept

@whedon
Copy link
Author

whedon commented Nov 6, 2018

Attempting dry run of processing paper acceptance...

@whedon
Copy link
Author

whedon commented Nov 6, 2018

Check final proof 👉 openjournals/joss-papers#48

If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#48, then you can now move forward with accepting the submission by compiling again with the flag deposit=true e.g.

@whedon accept deposit=true

@arfon
Copy link
Member

arfon commented Nov 6, 2018

@whedon accept deposit=true

@whedon
Copy link
Author

whedon commented Nov 6, 2018

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

@whedon
Copy link
Author

whedon commented Nov 6, 2018

🚨🚨🚨 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.00961 joss-papers#49
  2. Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/joss.00961
  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...

@arfon
Copy link
Member

arfon commented Nov 6, 2018

@hiendn, @dirmeier - many thanks for your reviews here, and to @yochannah for editing this submission ✨

@AleksandraDabrowska - your paper is now accepted into JOSS ⚡ 🚀 💥

@arfon arfon closed this as completed Nov 6, 2018
@whedon
Copy link
Author

whedon commented Nov 6, 2018

🎉🎉🎉 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](http://joss.theoj.org/papers/10.21105/joss.00961/status.svg)](https://doi.org/10.21105/joss.00961)

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

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

This is how it will look in your documentation:

DOI

We need your help!

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 recommend-accept Papers recommended for acceptance in JOSS. review
Projects
None yet
Development

No branches or pull requests

6 participants