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]: WGS2NCBI - Toolkit for preparing genomes for submission to NCBI #1364

Closed
18 tasks done
whedon opened this issue Apr 4, 2019 · 39 comments
Closed
18 tasks done
Assignees
Labels
accepted published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. review

Comments

@whedon
Copy link

whedon commented Apr 4, 2019

Submitting author: @rvosa (Rutger Vos)
Repository: https://github.com/naturalis/wgs2ncbi
Version: v1.0.3
Editor: @lpantano
Reviewer: @druvus
Archive: 10.5281/zenodo.2645762

Status

status

Status badge code:

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

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

@druvus, 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 @lpantano know.

Please try and complete your review in the next two weeks

Review checklist for @druvus

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: v1.0.3
  • Authorship: Has the submitting author (@rvosa) 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
Copy link
Author

whedon commented Apr 4, 2019

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

whedon commented Apr 4, 2019

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Apr 4, 2019

@druvus
Copy link

druvus commented Apr 11, 2019

@rvosa I started to add issues to the wgs2ncbi repo regarding failing automatic tests, stalled help command and contribution documentation. Could you please take a look at them?

@rvosa
Copy link

rvosa commented Apr 11, 2019 via email

@druvus
Copy link

druvus commented Apr 17, 2019

thanks @rvosa ! I guess you should release an updated tagged version and update the manuscript to point to this new improved version.

@druvus
Copy link

druvus commented Apr 17, 2019

@lpantano I happy with wgs2ncbi once the article is updated to include a new updated version based on latest wgs2ncbi commit.

@rvosa
Copy link

rvosa commented Apr 17, 2019

I tagged the most recent commit as v1.0.1 but I forgot where I need to insert that tag in the submission?

@lpantano
Copy link

@whedon set v1.0.1 as version

@whedon
Copy link
Author

whedon commented Apr 17, 2019

OK. v1.0.1 is the version.

@lpantano
Copy link

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Apr 17, 2019

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Apr 17, 2019

@lpantano
Copy link

@whedon check references

@whedon
Copy link
Author

whedon commented Apr 17, 2019

Attempting to check references...

@whedon
Copy link
Author

whedon commented Apr 17, 2019


OK DOIs

- 10.1093/bib/bbv104 is OK
- 10.1093/nar/gku1216 is OK
- 10.1073/pnas.1314702110 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@lpantano
Copy link

Thanks @druvus for the review!

@rvosa, can you create a Zenodo archive of your repository and give me the DOI? The title needs to match the papers title and make sure authors are correct in Zenodo as well.

Thanks!

@rvosa
Copy link

rvosa commented Apr 18, 2019 via email

@rvosa
Copy link

rvosa commented Apr 18, 2019

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Apr 18, 2019

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Apr 18, 2019

@lpantano
Copy link

@whedon set v1.0.3 as version

@whedon
Copy link
Author

whedon commented Apr 19, 2019

OK. v1.0.3 is the version.

@lpantano
Copy link

@whedon set 10.5281/zenodo.2645762 as archive

@whedon
Copy link
Author

whedon commented Apr 19, 2019

OK. 10.5281/zenodo.2645762 is the archive.

@lpantano
Copy link

Ok, @openjournals/joss-eics I think we are done. Please let me know if something is off.

@arfon
Copy link
Member

arfon commented Apr 19, 2019

@whedon accept

@whedon
Copy link
Author

whedon commented Apr 19, 2019

Attempting dry run of processing paper acceptance...

@whedon
Copy link
Author

whedon commented Apr 19, 2019

PDF failed to compile for issue #1364 with the following error:

/app/vendor/ruby-2.4.4/lib/ruby/2.4.0/find.rb:43:in block in find': No such file or directory - tmp/1364 (Errno::ENOENT) from /app/vendor/ruby-2.4.4/lib/ruby/2.4.0/find.rb:43:in collect!'
from /app/vendor/ruby-2.4.4/lib/ruby/2.4.0/find.rb:43:in find' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-a1723d160bb6/lib/whedon/processor.rb:57:in find_paper_paths'
from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-a1723d160bb6/bin/whedon:73:in compile' from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/command.rb:27:in run'
from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/invocation.rb:126:in invoke_command' from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor.rb:387:in dispatch'
from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/base.rb:466:in start' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-a1723d160bb6/bin/whedon:116:in <top (required)>'
from /app/vendor/bundle/ruby/2.4.0/bin/whedon:23:in load' from /app/vendor/bundle/ruby/2.4.0/bin/whedon:23:in

'

@whedon
Copy link
Author

whedon commented Apr 19, 2019


OK DOIs

- 10.1093/bib/bbv104 is OK
- 10.1093/nar/gku1216 is OK
- 10.1073/pnas.1314702110 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@arfon
Copy link
Member

arfon commented Apr 19, 2019

@whedon accept

@whedon
Copy link
Author

whedon commented Apr 19, 2019

Attempting dry run of processing paper acceptance...

@whedon
Copy link
Author

whedon commented Apr 19, 2019


OK DOIs

- 10.1093/bib/bbv104 is OK
- 10.1093/nar/gku1216 is OK
- 10.1073/pnas.1314702110 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Apr 19, 2019

Check final proof 👉 openjournals/joss-papers#633

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

@whedon accept deposit=true

@arfon
Copy link
Member

arfon commented Apr 19, 2019

@whedon accept deposit=true

@whedon
Copy link
Author

whedon commented Apr 19, 2019

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

@whedon
Copy link
Author

whedon commented Apr 19, 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 👉 Creating pull request for 10.21105.joss.01364 joss-papers#634
  2. Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/joss.01364
  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
Copy link
Member

arfon commented Apr 19, 2019

@druvus - many thanks for your review and to @lpantano for editing this one ✨

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

@arfon arfon closed this as completed Apr 19, 2019
@whedon
Copy link
Author

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

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

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

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
Labels
accepted published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. review
Projects
None yet
Development

No branches or pull requests

5 participants