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]: Philentropy: Information Theory and Distance Quantification with R #765

Closed
whedon opened this Issue Jun 6, 2018 · 17 comments

Comments

Projects
None yet
5 participants
@whedon
Collaborator

whedon commented Jun 6, 2018

Submitting author: @HajkD (Hajk-Georg Drost)
Repository: https://github.com/HajkD/philentropy
Version: v0.2.0
Editor: @leeper
Reviewer: @kellieotto
Archive: 10.5281/zenodo.1286221

Status

status

Status badge code:

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

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

@kellieotto, 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 @leeper know.

Review checklist for @kellieotto

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

Collaborator

whedon commented Jun 6, 2018

Hello human, I'm @whedon. I'm here to help you with some common editorial tasks. @kellieotto 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

This comment has been minimized.

Collaborator

whedon commented Jun 6, 2018

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

This comment has been minimized.

Collaborator

whedon commented Jun 6, 2018

@kellieotto

This comment has been minimized.

Collaborator

kellieotto commented Jun 7, 2018

I've completed my first review. I noted issues with the license and performance claims in issues in the repository.

@HajkD

This comment has been minimized.

HajkD commented Jun 7, 2018

Dear Kellie,

Thank you so so much for compiling a review so quickly.
It is very much appreciated.

I will address all your points in detail and will add the missing LICENSE file.

Many thanks and kind regards,
Hajk

@HajkD

This comment has been minimized.

HajkD commented Jun 8, 2018

Dear all,

I incorporated all changes and addressed the two issues listed above.

Many thanks and kind regards,
Hajk

@leeper

This comment has been minimized.

Member

leeper commented Jun 8, 2018

@kellieotto Can you take a look and see if there are any further issues to address?

@kellieotto

This comment has been minimized.

Collaborator

kellieotto commented Jun 9, 2018

@leeper Everything looks good now.

@leeper

This comment has been minimized.

Member

leeper commented Jun 9, 2018

@HajkD Please issue a GitHub release for the current version of the software, and create a DOI for that release using, for example, figshare or Zenodo. Once you have the DOI, please leave it here as a comment. Once that's done, your paper will be accepted at JOSS!

@kellieotto Thanks so much for your very quick review!

@HajkD

This comment has been minimized.

HajkD commented Jun 9, 2018

Dear @leeper,

Thank you so much for organizing everything.

Here is the doi I generated:

https://doi.org/10.5281/zenodo.1286221

@kellieotto Thank you very very much for your great and super fast review.

This was a great experience and I will definitely recommend JOSS!

Kind regards,
Hajk

@kellieotto

This comment has been minimized.

Collaborator

kellieotto commented Jun 9, 2018

You're welcome! Always happy to review for JOSS.

@leeper

This comment has been minimized.

Member

leeper commented Jun 9, 2018

@whedon set 10.5281/zenodo.1286221 as archive

@whedon

This comment has been minimized.

Collaborator

whedon commented Jun 9, 2018

OK. 10.5281/zenodo.1286221 is the archive.

@leeper

This comment has been minimized.

Member

leeper commented Jun 9, 2018

@arfon over to you

@arfon arfon added the accepted label Jun 11, 2018

@arfon

This comment has been minimized.

Member

arfon commented Jun 11, 2018

@kellieotto - many thanks for your review and to @leeper for editing this submission

@HajkD - your paper is now accepted into JOSS and your DOI is https://doi.org/10.21105/joss.00765 ⚡️ 🚀 💥

@arfon arfon closed this Jun 11, 2018

@whedon

This comment has been minimized.

Collaborator

whedon commented Jun 11, 2018

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

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

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

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:

@HajkD

This comment has been minimized.

HajkD commented Jun 11, 2018

Dear all,

Thank you so so much for your great work and for the super fast editorial/review process.

This is my first JOSS paper and I will definitely consider submitting future tools to JOSS as well. In addition, I will also highly recommend it to my colleagues.

Kind regards,
Hajk

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment