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]: SuchTree : A Python library for fast, thread-safe computations on phylogenetic trees #678

Closed
18 tasks done
whedon opened this issue Apr 16, 2018 · 34 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 16, 2018

Submitting author: @ryneches (Russell Y. Neches)
Repository: https://github.com/ryneches/SuchTree
Version: 0.6
Editor: @karthik
Reviewer: @giraola
Archive: 10.5281/zenodo.1294297

Status

status

Status badge code:

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

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

@giraola, 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.

Review checklist for @giraola

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 (0.6)?
  • Authorship: Has the submitting author (@ryneches) 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 16, 2018

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

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Apr 16, 2018

@ryneches
Copy link

ryneches commented Apr 27, 2018

Article proof looks good to me, aside from missing a reference for FastTree. D'oh.

@giraola
Copy link

giraola commented Apr 28, 2018

@ryneches please add DOIs to all references listed in the manuscript.

@ryneches
Copy link

Done. I also added references for FastTree. Hmm... do I ask @whedon to make a new proof?

@karthik
Copy link
Contributor

karthik commented May 1, 2018

@whedon generate pdf

@whedon
Copy link
Author

whedon commented May 1, 2018

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented May 1, 2018

@ryneches
Copy link

ryneches commented May 1, 2018

@whedon generate pdf

@whedon
Copy link
Author

whedon commented May 1, 2018

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented May 1, 2018

@ryneches
Copy link

ryneches commented May 1, 2018

Hmm. I'm not happy with the way the references are getting formatted. Multiple references look weird, and BibTeX is doing that thing where it turns repeated author lists into a long dash. :-/

Is there a formatting guide? I'm not so familiar with the MarkDown to LaTeX way of doing things.

@arfon
Copy link
Member

arfon commented May 3, 2018

Hmm. I'm not happy with the way the references are getting formatted. Multiple references look weird, and BibTeX is doing that thing where it turns repeated author lists into a long dash. :-/

This is the standard style for our bibliography - it's because the author list of the second paper is the same as the one above it.

@ryneches
Copy link

ryneches commented May 7, 2018

Ah, OK. I've always thought looks weird.

@ryneches
Copy link

What's next?

@arfon
Copy link
Member

arfon commented May 18, 2018

What's next?

I think we're waiting for @giraola to finish their review?

@giraola
Copy link

giraola commented May 18, 2018

Hi @arfon @ryneches, sorry for the delay, I will complete it within the following two of days...

@giraola
Copy link

giraola commented May 18, 2018

@ryneches please add installation guidelines and list SuchTree dependencies in the readme file.

@ryneches
Copy link

ryneches commented May 20, 2018

Added.

@ryneches
Copy link

ryneches commented Jun 1, 2018

Anything else?

@giraola
Copy link

giraola commented Jun 12, 2018

@ryneches I just completed the revision. Sorry for this delay.

@arfon
Copy link
Member

arfon commented Jun 15, 2018

@karthik - I think this paper is good to accept?

@karthik
Copy link
Contributor

karthik commented Jun 19, 2018

@arfon Yes, definitely. I communicated with Russel before I left for my trip and am just returning to editorial duties. Will finish this up asap.

@karthik
Copy link
Contributor

karthik commented Jun 19, 2018

@ryneches So sorry for the delay. This is good to go and thanks for your patience!
🙏

Now, can you deposit the software on Zenodo and post a DOI here so we can complete the final steps towards acceptance?

@ryneches
Copy link

All right! After a little tidying up, here's the Zenodo DOI :

https://doi.org/10.5281/zenodo.1294297

@karthik
Copy link
Contributor

karthik commented Jun 22, 2018

@whedon set 10.5281/zenodo.1294297 as archive

@whedon
Copy link
Author

whedon commented Jun 22, 2018

OK. 10.5281/zenodo.1294297 is the archive.

@karthik
Copy link
Contributor

karthik commented Jun 22, 2018

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Jun 22, 2018

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Jun 22, 2018

@karthik
Copy link
Contributor

karthik commented Jun 22, 2018

@ryneches Congrats on your paper being accepted! 🎉
@arfon will do a couple more steps to finalize your paper.

@arfon arfon added the accepted label Jun 22, 2018
@arfon
Copy link
Member

arfon commented Jun 22, 2018

@ryneches - I made a small fix to one of your bibtex entries which wasn't working in ryneches/SuchTree#14

@giraola - many thanks for your review here and to @karthik for editing this submission ✨

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

@arfon arfon closed this as completed Jun 22, 2018
@whedon
Copy link
Author

whedon commented Jun 22, 2018

🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉

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.00678/status.svg)](https://doi.org/10.21105/joss.00678)

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