Joss-reviews: [REVIEW]: CheSweet: An application to predict glycan’s chemicals shifts

Created on 6 Dec 2017  ·  25Comments  ·  Source: openjournals/joss-reviews

Submitting author: @PabloGGaray (Pablo Garay)
Repository: https://github.com/BIOS-IMASL/chesweet
Version: 0.0.1
Editor: @arfon
Reviewer: @richardjgowers
Archive: 10.5281/zenodo.1157129

Status

status

Status badge code:

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

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

@richardjgowers, 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 @arfon know.

Conflict of interest

Code of Conduct

General checks

  • [x] Repository: Is the source code for this software available at the repository url?
  • [x] License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • [x] Version: Does the release version given match the GitHub release (0.0.1)?
  • [x] Authorship: Has the submitting author (@PabloGGaray) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

Functionality

  • [x] Installation: Does installation proceed as outlined in the documentation?
  • [x] Functionality: Have the functional claims of the software been confirmed?
  • [x] 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

  • [x] A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • [x] Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • [x] Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • [x] Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • [x] Automated tests: Are there automated tests or manual steps described so that the function of the software can be verified?
  • [x] 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

  • [x] Authors: Does the paper.md file include a list of authors with their affiliations?
  • [x] A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • [x] References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?
accepted published recommend-accept review

Most helpful comment

@richardjgowers - many thanks for your review here ✨

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

All 25 comments

Hello human, I'm @whedon. I'm here to help you with some common editorial tasks. @richardjgowers it looks like you're currently assigned as the reviewer for this paper :tada:.

:star: Important :star:

If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/openjournals/joss-reviews) repository. As as 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
Attempting PDF compilation. Reticulating splines etc...
https://github.com/openjournals/joss-papers/blob/joss.00488/joss.00488/10.21105.joss.00488.pdf

Hello @arfon, excuse me if this is not the place to do this question, but I have to add two line to the paper with the funding of the project, how I do that? I wait for the review or I can add that lines now?.
Thanks in advance and excuse me for the inconveniences.

@PabloGGaray - authors do this pretty regularly. I would suggest adding a new section header to the paper.md file:

# Funding

Anything you want to say about the funding source for the project...

I'll do that, thanks @arfon.

I made the change, I suppose you have to compile the paper.md again for the review, thanks.

@whedon generate pdf

Attempting PDF compilation. Reticulating splines etc...
https://github.com/openjournals/joss-papers/blob/joss.00488/joss.00488/10.21105.joss.00488.pdf

@arfon I've raised some issues on their repo, overall the paper + software looks good - I'd consider this minor revisions.

I also need to double check the maths of what's happening (functional claims of software, ie are the interpolations all behaving as they claim), but I can do this while they address the issues I've raised.

Great, thanks for the update @richardjgowers.

I also need to double check the maths of what's happening (functional claims of software, ie are the interpolations all behaving as they claim), but I can do this while they address the issues I've raised.

👍 let me know when you're done and satisfied with the submission.

@richardjgowers - any update here?

@arfon the issues I raised have been addressed by the authors, so this can be accepted now

@PabloGGaray - At this point could you make an archive of the reviewed software in Zenodo/figshare/other service and update this thread with the DOI of the archive? I can then move forward with accepting the submission.

Hi @arfon this is the DOI: 10.5281/zenodo.1157129
Just in case that not work correctly this is the entry in zenodo.
And thanks for your work @richardjgowers.

@whedon set 10.5281/zenodo.1157129 as archive

OK. 10.5281/zenodo.1157129 is the archive.

@richardjgowers - many thanks for your review here ✨

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

:tada::tada::tada: Congratulations on your paper acceptance! :tada::tada::tada:

If you would like to include a link to your paper from your README use the following code snippet:

[![DOI](http://joss.theoj.org/papers/10.21105/joss.00488/status.svg)](https://doi.org/10.21105/joss.00488)

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 volunteering to review for us sometime in the future. You can add your name to the reviewer list here: http://joss.theoj.org/reviewer-signup.html

Hello @arfon, Its possible make little changes in the paper?
We committed a little mistake in the affiliation information, the name of our institution is "Instituto de Matemática Aplicada San Luis", we omitted the "Aplicada" in the name by mistake.
And, if it is possible another change, in one reference the names of the authors don't appear, but we don't know the cause of this last problem.

Sure. Please make the edits to the paper.md file and I can regenerate the
PDF.

On Thu, Jan 25, 2018 at 1:04 PM, Pablo G Garay notifications@github.com
wrote:

Hello @arfon https://github.com/arfon, Its possible make little changes
in the paper?
We committed a little mistake in the affiliation information, the name of
our institution is "Instituto de Matemática Aplicada San Luis", we
omitted the "Aplicada" in the name by mistake.
And, if it is possible another change, in one reference the names of the
authors don't appear, but we don't know the cause of this last problem.


You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
https://github.com/openjournals/joss-reviews/issues/488#issuecomment-360549737,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AGjvLogciFHZ6G88mzQWuGts-EQADeaZks5tOMJKgaJpZM4Q38yB
.

We made the change @arfon, the paper.md is ready for the regeneration of the PDF.

Great. I've updated the paper now. It may take a few hours to show the updated version on the JOSS site as the papers are cached.

Perfect, thanks!

Was this page helpful?
0 / 5 - 0 ratings