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]: sdmbench: An R Package for Benchmarking Species Distribution Models #847

Closed
whedon opened this Issue Jul 25, 2018 · 41 comments

Comments

Projects
None yet
6 participants
@whedon
Collaborator

whedon commented Jul 25, 2018

Submitting author: @boyanangelov (Boyan Angelov)
Repository: https://github.com/boyanangelov/sdmbench
Version: v0.1.2
Editor: @karthik
Reviewer: @sckott, @goldingn
Archive: 10.5281/zenodo.1436376

Status

status

Status badge code:

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

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

@sckott & @goldingn, 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 @karthik know.

Please try and complete your review in the next two weeks

Review checklist for @sckott

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.1.2)?
  • Authorship: Has the submitting author (@boyanangelov) 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 @goldingn

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.1.2)?
  • Authorship: Has the submitting author (@boyanangelov) 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 Jul 25, 2018

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

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

This comment has been minimized.

Collaborator

whedon commented Jul 25, 2018

@karthik

This comment has been minimized.

Collaborator

karthik commented Jul 25, 2018

🙏 very much @sckott, @goldingn. Please let me know if you have any questions about the review process.

@goldingn

This comment has been minimized.

Collaborator

goldingn commented Aug 1, 2018

Software paper review

Hi @boyanangelov, here's a short review of the software paper:

I think it reads really well. The statements of the problem that SDM solves, and the issue of benchmarking SDMs that sdmbench solves, are nice and succinct. The rest of the document does a nice job of explaining what the package provides that others don't. Great work!

Affiliation

You don't have an affiliation listed. Was that deliberate?

Citations

One of the citations has as the author: "Datasets, Healthcare Mimic", which looks like a bibtex malformation of the author. You should be able to change the author to: "Healthcare MIMIC Datasets" (which I'm guessing you were after) by editing the bibtex entry to have {}s around the author, like this. Though there's also this version of the paper, with a human name for the author, so maybe that's worth using instead.

The citation for Wu et al. doesn't have a date. Maybe it would be worth citing this dated arxiv paper instead.

The ENMeval citation has smallcaps html tags for Maxent, that didn't render properly in the bibliography. It's probably possible to get them working in the file (e.g. here?), or you could just omit the small caps, as in the Google Scholar bibtex version.

@boyanangelov

This comment has been minimized.

boyanangelov commented Aug 1, 2018

Hi @goldingn,

Thank you for the positive opinion on the paper. About the affiliation - yes, at the moment I am not formally academically affiliated. I work as a machine learning researcher in the industry but in a different field.

I pushed the citation changes to Github, I hope they are fixed now. Thanks again for taking the time to review this package!

@goldingn

This comment has been minimized.

Collaborator

goldingn commented Aug 1, 2018

Awesome!

Maybe @karthik can advise on what to put on the affiliation line?

I should get to the rest of the package review early next week.

@karthik

This comment has been minimized.

Collaborator

karthik commented Aug 7, 2018

@boyanangelov Can you use a former institution if any part of this work was begun while employed there? If not, you should just use your current employer as the affiliation.

@boyanangelov

This comment has been minimized.

boyanangelov commented Aug 8, 2018

@karthik Thank you for the suggestions, I just added my current employer as the affiliation.

@sckott

This comment has been minimized.

Member

sckott commented Aug 16, 2018

software

  • had an issue with the vignette building locally for me, and examples seemed to be not in sync with (issue 4) - it's not quite clear to me if the rendered vignette online is behind the v0.1.2 tagged version or ahead?
  • some notes on GBIF data (issue 5)
  • For Statement of Need, i'd say that's partially fulfilled. the problem is clearly stated but i don't see a clear statment of who the software is targeted at
  • For Installation Instructions, i think the github repo (Readme, vignette) could use more instructions given that it depends on Python and Java and Maxent (a separate standalone piece of software), like what to do if users are having trouble with a python dependency or virtualenv or python version, etc.
  • For Functionality documentation, as someone not super familiar with SDM's and macine learning, i'd love more documentation in each fxns man page about what possible values are for each parameter (if there's a finite set), etc.
  • i'd pull the Code of Conduct out of the contributing file into a separate file CODE_OF_CONDUCT.md

paper

  • Wu et al. has a DOI: https://doi.org/10.1039/C7SC02664A
  • affilitation not present for author, already pointed out by other reviewer
  • author does a nice job introducing the problem and defining how this effort is different from previous art
  • "The data processing pipeline relies on external functions" maybe is more accurate as "software" or "packages" cause in theory a function doesn't need to be in a package :)
@boyanangelov

This comment has been minimized.

boyanangelov commented Aug 21, 2018

Hello @sckott. First, thank you for taking the time to review the software and the paper!

I just pushed my attempt at addressing your feedback. I left one of the the issues open since I am not 100% sure if I have fulfilled the criteria. Let me know what you think, and thanks again!

@sckott

This comment has been minimized.

Member

sckott commented Aug 21, 2018

thanks, will have a look

@goldingn

This comment has been minimized.

Collaborator

goldingn commented Aug 27, 2018

@boyanangelov sorry for being so slow with the code review. I've been away for a few weeks, but have tomorrow afternoon blocked out to get my comments to you!

@boyanangelov

This comment has been minimized.

boyanangelov commented Aug 27, 2018

@goldingn no worries. Take your time :)

@whedon

This comment has been minimized.

Collaborator

whedon commented Aug 28, 2018

Here are some things you can ask me to do:

# List Whedon's capabilities
@whedon commands

# List of editor GitHub usernames
@whedon list editors

# List of reviewers together with programming language preferences and domain expertise
@whedon list reviewers

🚧 🚧 🚧 Experimental Whedon features 🚧 🚧 🚧

# Compile the paper
@whedon generate pdf

@goldingn

This comment has been minimized.

Collaborator

goldingn commented Aug 28, 2018

@whedon generate pdf

@whedon

This comment has been minimized.

Collaborator

whedon commented Aug 28, 2018

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

This comment has been minimized.

Collaborator

whedon commented Aug 28, 2018

@goldingn

This comment has been minimized.

Collaborator

goldingn commented Aug 28, 2018

Wow, thanks @whedon! I for one welcome ... etc.

@goldingn

This comment has been minimized.

Collaborator

goldingn commented Aug 28, 2018

code review

@boyanangelov great work! My code review is going to be pretty short, since @sckott has covered some important points, and my comments are covered by the following issues, some of which you've already addressed:

The main outstanding issues are that the function-level documentation is insufficient at present, and that the maxent-related functions, vignette, and tests all fail for me, even though I have all the dependencies as stated.
I appreciate that the latter will be a pain for you to debug, so I'll have a go at debugging it myself now, and I'm happy to retry as you push attempted fixes, just tag me in an issue if you want me to run something!

@boyanangelov

This comment has been minimized.

boyanangelov commented Sep 6, 2018

@goldingn and @sckott I pushed changes for the remaining issues and added a few comments on them.

@karthik

This comment has been minimized.

Collaborator

karthik commented Sep 6, 2018

@boyanangelov Thanks very much. FYI Scott is on vacation for another week but I will ping him when he's back to finish his review.

@karthik

This comment has been minimized.

Collaborator

karthik commented Sep 6, 2018

@whedon generate pdf

@whedon

This comment has been minimized.

Collaborator

whedon commented Sep 6, 2018

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

This comment has been minimized.

Collaborator

whedon commented Sep 6, 2018

@goldingn

This comment has been minimized.

Collaborator

goldingn commented Sep 10, 2018

Awesome, now it's just those undocumented functions to sort out from my end

@boyanangelov

This comment has been minimized.

boyanangelov commented Sep 10, 2018

Thanks @goldingn. Just pushed the fixes for the undocumented functions.

@goldingn

This comment has been minimized.

Collaborator

goldingn commented Sep 11, 2018

Great! All ticks from me now. Good job!

@karthik

This comment has been minimized.

Collaborator

karthik commented Sep 23, 2018

@sckott Are you ok with signing off on this?

@sckott

This comment has been minimized.

Member

sckott commented Sep 24, 2018

looking at it now

@sckott

This comment has been minimized.

Member

sckott commented Sep 24, 2018

Happy with it now. I did open an issue boyanangelov/sdmbench#9 when trying to run examples, but I imagine it's just an outdated readme issue or so

@boyanangelov

This comment has been minimized.

boyanangelov commented Sep 24, 2018

@sckott You are right, some code that was necessary as a previous step was missing from the README. I just pushed the changes.

@karthik

This comment has been minimized.

Collaborator

karthik commented Sep 26, 2018

Thanks @boyanangelov! Can you please archive your software on Zenodo and post a DOI so we proceed with next steps? 🙏

@boyanangelov

This comment has been minimized.

boyanangelov commented Sep 27, 2018

@karthik Great! I just made a release with all the JOSS review fixes and improvements (v.0.1.3), archived in Zenodo (http://doi.org/10.5281/zenodo.1436376) and changed the DOI and version number in the paper.

@karthik

This comment has been minimized.

Collaborator

karthik commented Sep 28, 2018

@whedon set 10.5281/zenodo.1436376 as archive

@whedon

This comment has been minimized.

Collaborator

whedon commented Sep 28, 2018

OK. 10.5281/zenodo.1436376 is the archive.

@karthik

This comment has been minimized.

Collaborator

karthik commented Sep 28, 2018

@arfon This is ready to accept (A few checklist items remain open but both reviewers have signed off). Thanks very much @sckott and @goldingn for the review! 🙏

@goldingn

This comment has been minimized.

Collaborator

goldingn commented Sep 28, 2018

🎉🎊🍾
Thanks for inviting me to review, and great work @boyanangelov!

@arfon arfon added the accepted label Sep 29, 2018

@arfon

This comment has been minimized.

Member

arfon commented Sep 29, 2018

@sckott, @goldingn - many thanks for your reviews here and to @karthik for editing this submission.

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

@arfon arfon closed this Sep 29, 2018

@whedon

This comment has been minimized.

Collaborator

whedon commented Sep 29, 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.00847/status.svg)](https://doi.org/10.21105/joss.00847)

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

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

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:

@boyanangelov

This comment has been minimized.

boyanangelov commented Sep 29, 2018

@sckott @goldingn Thank you for reviewing! The package improved greatly from your feedback. @karthik thank you for organizing everything, and @arfon thank you and everyone else at JOSS for this journal - I will be gladly recommending it to my colleagues!

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