search

openjournals / joss-reviews

Reviews for the Journal of Open Source Software
Creative Commons Zero v1.0 Universal
722 stars 38 forks source link

[REVIEW]: Phonetic Algorithms in R #480

Closed whedon closed 6 years ago

whedon commented 6 years ago

Submitting author: @howardjp (James P. Howard, II) Repository: https://github.com/howardjp/phonics Version: v0.7.6 Editor: @jasonclark Reviewer: @alexhanna Archive: 10.5281/zenodo.1041982

Status

status

Status badge code:

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

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

@alexhanna, 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 @jasonclark know.

Conflict of interest

Code of Conduct

General checks

Functionality

Documentation

Software paper

whedon commented 6 years ago

Hello human, I'm @whedon. I'm here to help you with some common editorial tasks. @alexhanna 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
whedon commented 6 years ago 
Attempting PDF compilation. Reticulating splines etc...
whedon commented 6 years ago 
https://github.com/openjournals/joss-papers/blob/joss.00480/joss.00480/10.21105.joss.00480.pdf
howardjp commented 6 years ago

@alexhanna Just wanted to give you a heads up, there are a handful of non-substantive changes in the development branch. If/when this paper is approved, I intend to push 1.0.0, so this paper will ultimately describe that version.

jasonclark commented 6 years ago

@alexhanna Let me know if you have questions about this review. I'm around all next week.

alexhanna commented 6 years ago

Thanks, Jason. Will get to this this week.

On Sun, Dec 17, 2017 at 12:33 AM, Jason A. Clark notifications@github.com wrote:

@alexhanna https://github.com/alexhanna Let me know if you have questions about this review. I'm around all next week.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/openjournals/joss-reviews/issues/480#issuecomment-352219458, or mute the thread https://github.com/notifications/unsubscribe-auth/AAwvDTvX4ZtDxQGpgojWnjhbGxVoXfvMks5tBFM0gaJpZM4Qz6sG .

-- Alex Hanna alex-hanna.com @alexhanna

alexhanna commented 6 years ago

Sorry, it's been much longer than a week.

This looks generally good. Things that are missing:

Otherwise code looks good and all the tests check out.

howardjp commented 6 years ago

@alexhanna Hello, it's all good, we have our off days.

With respect to the license, the R package system demands that a file called "LICENSE" exist and in the format shown. If you're agreeable, I could add a COPYRIGHT.md file that included the BSD license information?

I have "Contribution guidelines" in the README. Do I need to break this out into a separate file?

Finally, as for an API, every function is documented (I wouldn't be able to pass the R release checks if not). The manual is completely produced at install time. Here's a link to the automatically generated PDF.

alexhanna commented 6 years ago

On Sun, Jan 21, 2018 at 8:28 PM, James Howard notifications@github.com wrote:

@alexhanna https://github.com/alexhanna Hello, it's all good, we have our off days.

With respect to the license, the R package system demands that a file called "LICENSE" exist and in the format show. If you're agreeable, I could add a COPYRIGHT.md file that included the BSD license information?

I have "Contribution guidelines" in the README. Do I need to break this out into a separate file?

Finally, as for an API, every function is documented (I wouldn't be able to pass the R release checks if not). The manual is completely produced at install time. Here's a link to the automatically generated PDF https://cran.r-project.org/web/packages/phonics/phonics.pdf.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/openjournals/joss-reviews/issues/480#issuecomment-359301307, or mute the thread https://github.com/notifications/unsubscribe-auth/AAwvDUs8y1Di0eRob0-ey45cOlfpSDxyks5tM-Q5gaJpZM4Qz6sG .

-- Alex Hanna alex-hanna.com @alexhanna

howardjp commented 6 years ago

Awesome. I will add the COPYRIGHT file to develop branch. That shouldn't take more than a few seconds :)

howardjp commented 6 years ago

Well, it took more than a few seconds, but here we go. Done. As I noted, I plan to release a 1.0.0 with this article. So with that, I'll merge the changes into master.

alexhanna commented 6 years ago

Always takes longer than expected!

@jasonclark I think this one's good to go.

howardjp commented 6 years ago

Thank you very much, @alexhanna!

arfon commented 6 years ago

@jasonclark - is this ready to accept?

jasonclark commented 6 years ago

@arfon @alexhanna Yes, I think we are ready. This one got a bit caught up in the holidays cycle. Thanks for everyone's work to get us this far.

arfon commented 6 years ago

@howardjp - 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.

howardjp commented 6 years ago

Here ya go! https://doi.org/10.5281/zenodo.1041982

arfon commented 6 years ago

@whedon set 10.5281/zenodo.1041982 as archive

whedon commented 6 years ago

OK. 10.5281/zenodo.1041982 is the archive.

arfon commented 6 years ago

@alexhanna - many thanks for your review here and to @jasonclark for editing this submission ✨

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

whedon commented 6 years ago

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

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: