Skip to content

/joss-reviews

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]: TextWiller: collection of text mining utilities, specially devoted to the Italian language #1256

Open
whedon opened this issue Feb 15, 2019 · 11 comments

Comments

Assignees

@timClicks timClicks

@mgymrek mgymrek

Labels
review
Projects
None yet
Milestone
No milestone
5 participants
@whedon @mgymrek @timClicks @labarba @danielskatz
@whedon
Copy link
Collaborator

commented Feb 15, 2019 •
edited by timClicks

Submitting author: @scan2001 (andrea sciandra)
Repository: https://github.com/livioivil/TextWiller
Version: 2.0
Editor: @mgymrek
Reviewer: @timClicks
Archive: Pending

Status

status

Status badge code:

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

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

@timClicks, 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 @mgymrek know.

✨ Please try and complete your review in the next two weeks ✨

Review checklist for @timClicks

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 (2.0)?
  • Authorship: Has the submitting author (@scan2001) 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 whedon assigned mgymrek Feb 15, 2019

@whedon whedon added the review label Feb 15, 2019

@whedon whedon referenced this issue Feb 15, 2019

Closed

[PRE REVIEW]: TextWiller: collection of text mining utilities, specially devoted to the Italian language #1048

@whedon

This comment has been minimized.

Sign in to view
Copy link
Collaborator Author

commented Feb 15, 2019

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

Sign in to view
Copy link
Collaborator Author

commented Feb 15, 2019 

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

This comment has been minimized.

Sign in to view
Copy link
Collaborator Author

commented Feb 15, 2019

👉 Check article proof 📄 👈

@mgymrek

This comment has been minimized.

Sign in to view
Copy link

commented Feb 15, 2019

Copying from the pre-review thread from @timClicks :

Hi @scan2001, thanks for the paper submission. I'm not officially an assigned reviewer, but I've taken a quick look at the paper.

Let me start by saying that it's excellent to see NLP contributions to non-English languages.

Prior art

However, there are many text mining packages available, even sticking within the R community. I wonder if you should cite some of the other open source NLP packages and explain that they do not offer Italian stemming/normalisation?

From the review guidelines:

Submissions that implement solutions already solved in other software packages are accepted into JOSS provided that they meet the criteria listed above and cite prior similar work. [emphasis added]

Authorship

I believe that it's up to your team to decide on authorship, but the three authors don't match the authors listed in the DESCRIPTION file or the TextWiller-package.R file.

Also, from the contribution list, it's unclear what level of contribution that your first author has made? (I assume that some of the commit history has been lost)

Here is the relevant guidance from the review guidelines:

As part of the review process, you are asked to check whether the submitting author has made a ‘substantial contribution’ to the submitted software (as determined by the commit history) and to check that ‘the full list of paper authors seems appropriate and complete?’

Documentation

TextWiller's API documentation is in Italian. However, it looks comprehensive.

(Deferring to @mgymrek for an opinion about whether this is allowed)

Tests

TextWiller doesn't appear to have a comprehensive test suite.
@mgymrek

This comment has been minimized.

Sign in to view
Copy link

commented Feb 15, 2019

@timClicks thanks for starting the review! would you also be able to fill out the checklist here?
@mgymrek

This comment has been minimized.

Sign in to view
Copy link

commented Mar 4, 2019

Hi @timClicks I just wanted to check in on this
@timClicks

This comment has been minimized.

Sign in to view
Copy link
Collaborator

commented Mar 11, 2019

@mgymrek Apologies on the delay. Will make my way through installation this week.
@mgymrek

This comment has been minimized.

Sign in to view
Copy link

commented Mar 25, 2019

hi @timClicks I just wanted to ping you about the review. I see you've started the checklist.
@labarba

This comment has been minimized.

Sign in to view
Copy link
Member

commented Apr 15, 2019

👋 @timClicks — can you update us on your status with this review?
@mgymrek

This comment has been minimized.

Sign in to view
Copy link

commented Apr 25, 2019

@timClicks can you give us an update if you will be able to complete this review?

@whedon whedon assigned timClicks May 6, 2019

@danielskatz

This comment has been minimized.

Sign in to view
Copy link

commented May 20, 2019

👋 @timClicks - we haven't heard from you in about 10 weeks now - are you still planning to perform this review?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.