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]: hotsub - Command line tool to run batch jobs with ETL framework concurrently on cloud services #1069

Closed
whedon opened this Issue Nov 7, 2018 · 45 comments

Comments

Projects
None yet
5 participants
@whedon
Collaborator

whedon commented Nov 7, 2018

Submitting author: @otiai10 (Hiromu Ochiai)
Repository: https://github.com/otiai10/hotsub
Version: v0.10.0
Editor: @brainstorm
Reviewer: @reisingerf
Archive: 10.5281/zenodo.1482983

Status

status

Status badge code:

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

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

@reisingerf, 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 @brainstorm know.

Please try and complete your review in the next two weeks

Review checklist for @reisingerf

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.10.0)?
  • Authorship: Has the submitting author (@otiai10) 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 Nov 7, 2018

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

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

This comment has been minimized.

Collaborator

whedon commented Nov 7, 2018

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

% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed

0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0
0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0
100 16 0 16 0 0 209 0 --:--:-- --:--:-- --:--:-- 207
Error reading bibliography ./paper.bib (line 2, column 13):
unexpected "B"
expecting space or ","
Error running filter pandoc-citeproc:
Filter returned error status 1
Looks like we failed to compile the PDF

@brainstorm

This comment has been minimized.

Member

brainstorm commented Nov 7, 2018

@otiai10, could you please correct your paper.bib? See error above. Also, in the statement of need, I think that https://github.com/base2genomics/batchit should be pointed out perhaps?

@otiai10

This comment has been minimized.

otiai10 commented Nov 8, 2018

@brainstorm
Thank you. I will

  • Fix bib format
  • Update README.md and paper.md to specify the statement of need more clearly
  • Write available functionalities on README.md more clearly
  • Add CONTRIBUTING.md

otiai10 added a commit to otiai10/hotsub that referenced this issue Nov 8, 2018

@reisingerf

This comment has been minimized.

Collaborator

reisingerf commented Nov 9, 2018

@otiai10 could you please also put the output of hotsub run --help in the README.md?
It shows a lot of options and default values that are mentioned nowhere in the documentation.

@otiai10

This comment has been minimized.

otiai10 commented Nov 12, 2018

Thank you very much for taking time for review. I've patched some updates (mentioned above) to bib and md.
https://github.com/otiai10/hotsub

would appreciate any feedback

@reisingerf

This comment has been minimized.

Collaborator

reisingerf commented Nov 12, 2018

Thank you for the updates! This looks good to me now.

@brainstorm

This comment has been minimized.

Member

brainstorm commented Nov 12, 2018

@whedon generate pdf

@whedon

This comment has been minimized.

Collaborator

whedon commented Nov 12, 2018

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

This comment has been minimized.

Collaborator

whedon commented Nov 12, 2018

@brainstorm

This comment has been minimized.

Member

brainstorm commented Nov 12, 2018

@otiai10 Looks good to me now as well, could you please put it on Zenodo so I can assign/register the DOI over here?

Thanks!

@otiai10

This comment has been minimized.

otiai10 commented Nov 12, 2018

@brainstorm Thanks for everything.

https://zenodo.org/record/1482983#.W-j3m3ozbdQ
Does it work?

@brainstorm

This comment has been minimized.

Member

brainstorm commented Nov 12, 2018

@whedon set 10.5281/zenodo.1482983 as archive

@whedon

This comment has been minimized.

Collaborator

whedon commented Nov 12, 2018

OK. 10.5281/zenodo.1482983 is the archive.

@brainstorm

This comment has been minimized.

Member

brainstorm commented Nov 12, 2018

@whedon accept

@whedon

This comment has been minimized.

Collaborator

whedon commented Nov 12, 2018

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

This comment has been minimized.

Collaborator

whedon commented Nov 12, 2018

Check final proof 👉 openjournals/joss-papers#63

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

@whedon accept deposit=true
@brainstorm

This comment has been minimized.

Member

brainstorm commented Nov 12, 2018

@reisingerf @otiai10 Thanks much everyone!

@arfon LGTM, shall I deposit?

@arfon

This comment has been minimized.

Member

arfon commented Nov 12, 2018

@brainstorm - before we accept this, can we update the references to be actual citations in the text?

@otiai10 - Could you move the references you currently have in the paper.md file into a paper.bib file and cite them directly please? (You can read how to do that here)

Also, it looks like we need to add a date to the paper.md file.

@otiai10

This comment has been minimized.

otiai10 commented Nov 12, 2018

Thank you,

  • I think all the references on paper.md are listed on paper.md. Could you please specify what I should actually do more than this?
  • Should I add date to the paper.md as the date it put on Zenodo? : November 12, 2018
@arfon

This comment has been minimized.

Member

arfon commented Nov 12, 2018

  • I think all the references on paper.md are listed on paper.md. Could you please specify what I should actually do more than this?

Yes, you need to remove all of the content underneath the references section here and instead, cite the entries in your paper.bib inline in your paper body. When we compile the paper, the references will be compiled automatically.

  • Should I add date to the paper.md as the date it put on Zenodo? : November 12, 2018

That should be fine yes.

otiai10 added a commit to otiai10/hotsub that referenced this issue Nov 13, 2018

Remove contents of "Reference" section
so that automatically generated contents can be rendered underneath.
Related: openjournals/joss-reviews#1069
Link: openjournals/joss-reviews#1069 (comment)

otiai10 added a commit to otiai10/hotsub that referenced this issue Nov 13, 2018

@otiai10

This comment has been minimized.

otiai10 commented Nov 13, 2018

Thank you for advise, I was misunderstanding how to write references. I fixed the references and added the date to paper.md. Thank you.

@brainstorm

This comment has been minimized.

Member

brainstorm commented Nov 13, 2018

Sorry about that @arfon, good catch, will look more closely next time before pre-accepting :-S

@arfon

This comment has been minimized.

Member

arfon commented Nov 13, 2018

Sorry about that @arfon, good catch, will look more closely next time before pre-accepting :-S

😁np.

@arfon

This comment has been minimized.

Member

arfon commented Nov 13, 2018

@whedon generate pdf

@whedon

This comment has been minimized.

Collaborator

whedon commented Nov 13, 2018

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

This comment has been minimized.

Collaborator

whedon commented Nov 13, 2018

@arfon

This comment has been minimized.

Member

arfon commented Nov 13, 2018

OK, final step now @otiai10 is to actually cite the references in your paper text. For example, this citation for Azure needs to be something like:

Azure Batch by Microsoft [@AzureBatch] ...

This [@AzureBatch] syntax is the bibtex entry key and will be used by Pandoc to compile the references section. This section is now currently blank as you're not actually citing any of the bibtex entries in the body of your paper.

@otiai10

This comment has been minimized.

otiai10 commented Nov 13, 2018

@whedon generate pdf

@whedon

This comment has been minimized.

Collaborator

whedon commented Nov 13, 2018

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

This comment has been minimized.

Collaborator

whedon commented Nov 13, 2018

@arfon

This comment has been minimized.

Member

arfon commented Nov 13, 2018

@whedon accept

@whedon

This comment has been minimized.

Collaborator

whedon commented Nov 13, 2018

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

This comment has been minimized.

Collaborator

whedon commented Nov 13, 2018

Check final proof 👉 openjournals/joss-papers#64

If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#64, 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

This comment has been minimized.

Member

arfon commented Nov 13, 2018

@whedon accept deposit=true

@whedon

This comment has been minimized.

Collaborator

whedon commented Nov 13, 2018

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

@whedon whedon added the accepted label Nov 13, 2018

@whedon

This comment has been minimized.

Collaborator

whedon commented Nov 13, 2018

🚨🚨🚨 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#65
  2. Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/joss.01069
  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

This comment has been minimized.

Member

arfon commented Nov 13, 2018

@reisingerf - many thanks for your review here and to @brainstorm for editing this submission.

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

@arfon arfon closed this Nov 13, 2018

@whedon

This comment has been minimized.

Collaborator

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

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

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

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:

@otiai10

This comment has been minimized.

otiai10 commented Nov 14, 2018


@arfon
CC @friend1ws

Thank you for everything.

I'd like to ask if it's possible to add co-authors and acknowledgements, and update the paper.

This change is already merged to master and ready to generate pdf.

Thank you.

@arfon

This comment has been minimized.

Member

arfon commented Nov 14, 2018

@whedon generate pdf

@whedon

This comment has been minimized.

Collaborator

whedon commented Nov 14, 2018

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

This comment has been minimized.

Member

arfon commented Nov 14, 2018

I'd like to ask if it's possible to add co-authors and acknowledgements, and update the paper.

Sure thing. The paper is now updated.

@otiai10

This comment has been minimized.

otiai10 commented Nov 14, 2018

Thank you very much! 😄

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