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]: COSplay: Contrast Optimized Stimulation Player #1171

Open
whedon opened this Issue Jan 14, 2019 · 10 comments

Comments

Projects
None yet
5 participants
@whedon
Copy link
Collaborator

whedon commented Jan 14, 2019

Submitting author: @TheChymera (Horea-Ioan Ioanas)
Repository: https://github.com/IBT-FMI/COSplay/
Version: 1.1.1
Editor: @arokem
Reviewer: @damaggu, @effigies
Archive: Pending

Status

status

Status badge code:

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

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

@damaggu & @effigies, please carry out your reviews 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 @arokem know.

Please try and complete your review in the next two weeks

Review checklist for @damaggu

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 (1.1.1)?
  • Authorship: Has the submitting author (@TheChymera) 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 @effigies

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 (1.1.1)?
  • Authorship: Has the submitting author (@TheChymera) 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

whedon commented Jan 14, 2019

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @damaggu 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.

Copy link
Collaborator

whedon commented Jan 14, 2019

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

This comment has been minimized.

Copy link
Collaborator

whedon commented Jan 14, 2019

@arokem

This comment has been minimized.

Copy link
Collaborator

arokem commented Feb 4, 2019

Hey @effigies/@damaggu: have you had a chance to take a look?

@effigies

This comment has been minimized.

Copy link
Collaborator

effigies commented Feb 4, 2019

Ah, no. Thanks for the reminder. I'll make time this week.

@effigies

This comment has been minimized.

Copy link
Collaborator

effigies commented Feb 8, 2019

RE conflicts of interest, I've met @TheChymera in person within the last 4 years (Scipy 2017), and we've collaborated (mostly in the form of PR review) separately on Nipype.

Also, this week piled up on me, and there's no chance I'll have a proper review today. I will aim for next Wednesday.

@arokem

This comment has been minimized.

Copy link
Collaborator

arokem commented Feb 10, 2019

Hi @effigies: the in-person meeting does not constitute a COI, in my opinion.

I am not sure whether the software collaboration constitutes COI, though. Let's check with the EIC. @arfon : the author of this paper and the reviewer have collaborated in code review on another software package (nipype, mentioned above). Does this constitute a COI that should disqualify @effigies from reviewing this paper? It is "work that is funded or published" only in the sense that that software project receives funding and is publicly available, but I believe that the two have not been paid from the same source of funding or been co-authors on any publication resulting from that software (but may in the future be). Should I find another reviewer for this?

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Feb 11, 2019

Neither of these are a COI.

@damaggu

This comment has been minimized.

Copy link

damaggu commented Feb 11, 2019

@arokem, @danielskatz Sorry, I'll make some time this week as well. Regarding COI: I'm actually collaborating with @TheChymera on other projects, but haven't been involved in the development of COSplay. Does this constitute a problem? Regards

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Feb 11, 2019

@arokem, @danielskatz Sorry, I'll make some time this week as well. Regarding COI: I'm actually collaborating with @TheChymera on other projects, but haven't been involved in the development of COSplay. Does this constitute a problem? Regards

Yes, @arokem should try to find another reviewer in this case.

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