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]: cartoee: Publication quality maps using Earth Engine #1207

Closed
whedon opened this Issue Jan 27, 2019 · 33 comments

Comments

Projects
None yet
6 participants
@whedon
Copy link
Collaborator

whedon commented Jan 27, 2019

Submitting author: @KMarkert (Kel Markert)
Repository: https://github.com/kmarkert/cartoee
Version: 0.0.5
Editor: @lheagy
Reviewer: @Fil
Archive: 10.5281/zenodo.2552811

Status

status

Status badge code:

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

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

@Fil, 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 @lheagy know.

Please try and complete your review in the next two weeks

Review checklist for @Fil

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: 0.0.5
  • Authorship: Has the submitting author (@KMarkert) 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

whedon commented Jan 27, 2019

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

whedon commented Jan 27, 2019

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

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 27, 2019

@lheagy

This comment has been minimized.

Copy link
Member

lheagy commented Jan 27, 2019

👋 Hi @Fil, many thanks for being willing to review! In the main issue commentary above, there is a checklist to help guide your review. If possible, we would appreciate if you could complete your review within the next two weeks. If there is anything I can provide clarification on, please let me know.

@Fil

This comment has been minimized.

Copy link
Collaborator

Fil commented Jan 28, 2019

I don't believe that there is COI in this case, but just to make sure, let me state that I have been working on a similar tool, written in Javascript and WebGL, on and off for the last few years. You can see an (older) instance of this tool at URL.

@lheagy @KMarkert feel free to revoke me if this sounds (even slightly) annoying. For my part I see this rather as a good way to learn and maybe cooperate in the future.

[EDIT] After a more careful look at @KMarkert's project I don't think my own projects are that close to it. So my point was certainly too cautious.

@Fil Fil referenced this issue Jan 28, 2019

Closed

Review for JOSS #1

2 of 2 tasks complete
@Fil

This comment has been minimized.

Copy link
Collaborator

Fil commented Jan 30, 2019

@whedon commands

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 30, 2019

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

EDITORIAL TASKS

# Compile the paper
@whedon generate pdf

# Ask Whedon to check the references for missing DOIs
@whedon check references

@Fil

This comment has been minimized.

Copy link
Collaborator

Fil commented Jan 30, 2019

@lheagy all checked!

@KMarkert congratulations 🎉

@lheagy

This comment has been minimized.

Copy link
Member

lheagy commented Jan 30, 2019

@whedon check references

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 30, 2019

Attempting to check references...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 30, 2019


OK DOIs

- http://doi.org/10.1109/MCSE.2007.55 is OK
- http://doi.org/10.5281/zenodo.2542609 is OK
- http://doi.org/https://doi.org/10.1016/j.rse.2017.06.031 is OK

MISSING DOIs

- None

INVALID DOIs

- None
@lheagy

This comment has been minimized.

Copy link
Member

lheagy commented Jan 30, 2019

Many thanks @Fil for the speedy review!!

@KMarkert, could you please make a new release and ensure that the title of the zenodo archive is the same as your paper "cartoee: Publication quality maps using Earth Engine" and post the doi here? From there, we can proceed with publication 🎉

@KMarkert

This comment has been minimized.

Copy link

KMarkert commented Jan 30, 2019

@Fil Thank you very much for the reviews and helping make the package of higher quality.

@lheagy I have edited the name of the zenodo archive to reflect the name of the paper. Can you please confirm that I did this correctly? Here is the doi: https://dx.doi.org/10.5281/zenodo.2552811

@lheagy

This comment has been minimized.

Copy link
Member

lheagy commented Jan 30, 2019

@whedon set 10.5281/zenodo.2552811 as archive

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 30, 2019

OK. 10.5281/zenodo.2552811 is the archive.

@lheagy

This comment has been minimized.

Copy link
Member

lheagy commented Jan 30, 2019

@whedon set 0.0.5 as version

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 30, 2019

OK. 0.0.5 is the version.

@lheagy

This comment has been minimized.

Copy link
Member

lheagy commented Jan 30, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 30, 2019

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

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 30, 2019

@lheagy lheagy added the accepted label Jan 30, 2019

@lheagy

This comment has been minimized.

Copy link
Member

lheagy commented Jan 30, 2019

👋 Hi @arfon, this submission is ready for publication! Congrats @KMarkert 🎉

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Jan 30, 2019

Hi @lheagy - We've moved to rotating editors-in-chief, and this week it's me. For the future, please notify @joss-eics when there's a paper ready to go, or to otherwise get the person on-duty...

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Jan 30, 2019

@whedon accept

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 30, 2019

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

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 30, 2019

Check final proof 👉 openjournals/joss-papers#462

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

@whedon accept deposit=true
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 30, 2019


OK DOIs

- http://doi.org/10.1109/MCSE.2007.55 is OK
- http://doi.org/10.5281/zenodo.2542609 is OK
- http://doi.org/https://doi.org/10.1016/j.rse.2017.06.031 is OK

MISSING DOIs

- None

INVALID DOIs

- None
@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Jan 30, 2019

@whedon accept deposit=true

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 30, 2019

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

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Jan 30, 2019

Thanks for reviewing @Fil and editing @lheagy !

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 30, 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#463
  2. Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/joss.01207
  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...

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Jan 30, 2019

👋 @arfon - I don't see the paper itself, which should be at https://www.theoj.org/joss-papers/joss.01207/10.21105.joss.01207.pdf
Can you see what might have gone wrong?

@arfon

This comment has been minimized.

Copy link
Member

arfon commented Jan 30, 2019

Can you see what might have gone wrong?

The paper seems to be there now. Sometimes GitHub pages (where the PDFs are served from) takes longer than a few seconds to update.

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 31, 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](http://joss.theoj.org/papers/10.21105/joss.01207/status.svg)](https://doi.org/10.21105/joss.01207)

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

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

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