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]: ccostr: An R package for estimating mean costs with censored data #1593

Closed
whedon opened this issue Jul 24, 2019 · 65 comments

Comments

@whedon
Copy link
Collaborator

commented Jul 24, 2019

Submitting author: @LarsHernandez (Lars Nielsen)
Repository: https://github.com/HaemAalborg/ccostr
Version: v0.1.0
Editor: @csoneson
Reviewers: @joethorley, @tgerke
Archive: 10.5281/zenodo.3386740

Status

status

Status badge code:

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

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

@BarryDeCicco & @joethorley, 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.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @csoneson know.

Please try and complete your review in the next two weeks

Review checklist for @tgerke

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: v0.1.0
  • Authorship: Has the submitting author (@LarsHernandez) 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 @joethorley

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: v0.1.0
  • Authorship: Has the submitting author (@LarsHernandez) 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

This comment has been minimized.

Copy link
Collaborator Author

commented Jul 24, 2019

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @BarryDeCicco, @joethorley it looks like you're currently assigned to review 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

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@whedon generate pdf
@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Jul 24, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Jul 24, 2019

@csoneson

This comment has been minimized.

Copy link

commented Jul 24, 2019

@BarryDeCicco, @joethorley - please perform your reviews here (see instructions in the issue above). Don't hesitate to ping me if you have any questions!

@csoneson

This comment has been minimized.

Copy link

commented Jul 24, 2019

@LarsHernandez - please take a look at the reviewer checklists above and make sure that all the required parts are available in your submission - if not, you can fix that already now, to simplify the review process!

@joethorley

This comment has been minimized.

Copy link

commented Jul 24, 2019

@csoneson and @LarsHernandez

I've made a start on reviewing and filed some issues that require addressing.

I would strongly recommend that the authors study the freely available R packages by Hadley Wickham http://r-pkgs.had.co.nz and implement the best practices to R package development detailed in this book.

Although the methods are worthy of publication in JOSS the packaging of the code needs improvement.

@BarryDeCicco

This comment has been minimized.

Copy link

commented Jul 25, 2019

@BarryDeCicco

This comment has been minimized.

Copy link

commented Jul 25, 2019

@csoneson

This comment has been minimized.

Copy link

commented Jul 25, 2019

@BarryDeCicco Thanks, your comments showed up here. Probably the easiest is to comment directly in this GitHub issue (click on "view it on GitHub" in the bottom of your email), that avoids having to worry about email addresses etc. Also note that there is a checklist in the beginning of this issue, where you should check off the aspects that you find satisfactory in the submission (and either provide comments in this issue or open issues in the submitted repository for the points that you do not find satisfactorily addressed). As the authors update the submission, please keep ticking the boxes as you consider them fulfilled. All boxes need to be ticked by all reviewers in order to eventually accept the paper.

@BarryDeCicco

This comment has been minimized.

Copy link

commented Jul 25, 2019

@csoneson

This comment has been minimized.

Copy link

commented Jul 25, 2019

@BarryDeCicco - could you please clarify? Do you no longer wish to be a reviewer for this submission? And/or do you want to be removed from the list of JOSS reviewers for future submissions?

@csoneson

This comment has been minimized.

Copy link

commented Jul 29, 2019

ping @BarryDeCicco

@BarryDeCicco - could you please clarify? Do you no longer wish to be a reviewer for this submission? And/or do you want to be removed from the list of JOSS reviewers for future submissions?

@csoneson

This comment has been minimized.

Copy link

commented Aug 1, 2019

@zedtaha - would you be interested in reviewing this submission for JOSS?

@csoneson

This comment has been minimized.

Copy link

commented Aug 7, 2019

@tgerke - would you be interested in reviewing this submission for JOSS?

@LarsHernandez

This comment has been minimized.

Copy link

commented Aug 7, 2019

Hey @csoneson , thank you for your effort so far. I just returned from vacation and I've just been fixing some of the Github issues raised by @joethorley, and looked into the comments from @BarryDeCicco, thanks a lot for the issues/comments. This is my first submission/article, so i'm very new in this, but i guess the submission needs two reviewers right? If @tgerke doesn't answer i can try to suggest one, i think the primary focus is R and survival analysis, i can see two with both in the list.

@csoneson

This comment has been minimized.

Copy link

commented Aug 7, 2019

Hi @LarsHernandez - welcome back :) Yes, I would like to have two reviewers - I'm hoping either @zedtaha or @tgerke will be available, otherwise we'll keep looking!

@LarsHernandez

This comment has been minimized.

Copy link

commented Aug 7, 2019

Thanks, and that sounds good, also I've just added a standard code of conduct to the repository which should check the community guidelines box

@tgerke

This comment has been minimized.

Copy link

commented Aug 12, 2019

This looks really interesting! Happy to help. Will aim to tackle the review late this week, if that timeline works for you all.

@csoneson

This comment has been minimized.

Copy link

commented Aug 12, 2019

Thanks @tgerke - that sounds great!

@tgerke

This comment has been minimized.

Copy link

commented Sep 3, 2019

Yes all looks in order to me -- great work @LarsHernandez!

@csoneson

This comment has been minimized.

Copy link

commented Sep 3, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 3, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 3, 2019

@csoneson

This comment has been minimized.

Copy link

commented Sep 3, 2019

@whedon check references

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 3, 2019

Attempting to check references...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 3, 2019


OK DOIs

- 10.1093/biomet/87.2.329 is OK
- 10.1177/1536867X1501500305 is OK
- 10.1002/hec.1648 is OK
- 10.2307/2533947 is OK
- 10.1002/dir.20049 is OK
- 10.1002/sim.2882 is OK
- 10.1111/j.0006-341X.2001.01002.x is OK

MISSING DOIs

- None

INVALID DOIs

- None
@csoneson

This comment has been minimized.

Copy link

commented Sep 3, 2019

@LarsHernandez - I have sent a PR with some small modifications to the manuscript - please check and merge (and generate a new proof with @whedon generate pdf). Specifically, note that the link to the GitHub repository will be given on the first page of the article, and does not need to be repeated in the text.

Next, please:

  • check that the version information is consistently reported
  • create a tagged release of the software
  • make a Zenodo archive. Note that the archive should have the same title and authors as the article (you can also add authors' ORCID)
  • report back here with the version number and the DOI of the Zenodo archive
@LarsHernandez

This comment has been minimized.

Copy link

commented Sep 5, 2019

  • check that the version information is consistently reported:
    I've removed some experimentation with a new estimator, BTp, and released it with version 0.1.0.. it passes all tests and the CMD check.. I've created a branch Version-0.1.1 and added the BTp function, so that might be added to the MASTER sometime in the future.

  • create a tagged release of the software:
    I did the Github release, hope that is what you meant.

@LarsHernandez

This comment has been minimized.

Copy link

commented Sep 5, 2019

  • make a Zenodo archive. Note that the archive should have the same title and authors as the article (you can also add authors' ORCID):
    link

  • report back here with the version number and the DOI of the Zenodo archive
    version: 0.1.0
    doi: 10.5281/zenodo.3386740

@LarsHernandez

This comment has been minimized.

Copy link

commented Sep 5, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 5, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 5, 2019

@csoneson

This comment has been minimized.

Copy link

commented Sep 5, 2019

@whedon set 10.5281/zenodo.3386740 as archive

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 5, 2019

OK. 10.5281/zenodo.3386740 is the archive.

@csoneson

This comment has been minimized.

Copy link

commented Sep 5, 2019

@whedon set v0.1.0 as version

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 5, 2019

OK. v0.1.0 is the version.

@csoneson

This comment has been minimized.

Copy link

commented Sep 5, 2019

@whedon accept

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 5, 2019

Attempting dry run of processing paper acceptance...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 5, 2019

Check final proof 👉 openjournals/joss-papers#948

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

@whedon accept deposit=true
@csoneson

This comment has been minimized.

Copy link

commented Sep 5, 2019

Thanks @LarsHernandez - this looks all good. I'll hand over to the AEiC on duty, who will do the final steps.
@openjournals/joss-eics - this paper is ready to be accepted!

@LarsHernandez

This comment has been minimized.

Copy link

commented Sep 5, 2019

Thanks everyone on making my first paper submission so pleasant 😀

@arfon

This comment has been minimized.

Copy link
Member

commented Sep 5, 2019

@whedon accept deposit=true

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 5, 2019

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

@whedon whedon added the accepted label Sep 5, 2019

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 5, 2019

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

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 5, 2019

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

This comment has been minimized.

Copy link
Member

commented Sep 5, 2019

@joethorley, @tgerke - many thanks for your reviews here and to @csoneson for editing this submission

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

@arfon arfon closed this Sep 5, 2019

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 5, 2019

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

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

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

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
Projects
None yet
7 participants
You can’t perform that action at this time.