search

openjournals / joss-reviews

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

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

Closed whedon closed 5 years ago

whedon commented 6 years ago

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

Author instructions

Thanks for submitting your paper to JOSS @scan2001. The JOSS editor (shown at the top of this issue) will work with you on this issue to find a reviewer for your submission before creating the main review issue.

@scan2001 if you have any suggestions for potential reviewers then please mention them here in this thread. In addition, this list of people have already agreed to review for JOSS and may be suitable for this submission.

Editor instructions

The JOSS submission bot @whedon is here to help you find and assign reviewers and start the main review. To find out what @whedon can do for you type:

@whedon commands
whedon commented 6 years ago

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks.

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

Failed to discover a valid open source license.

whedon commented 6 years ago

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

/app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-8e8528b72684/lib/whedon/orcid_validator.rb:12:in initialize': undefined methodstrip' for nil:NilClass (NoMethodError) from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-8e8528b72684/lib/whedon.rb:91:in new' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-8e8528b72684/lib/whedon.rb:91:inblock in check_orcids' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-8e8528b72684/lib/whedon.rb:89:in each' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-8e8528b72684/lib/whedon.rb:89:incheck_orcids' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-8e8528b72684/lib/whedon.rb:70:in initialize' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-8e8528b72684/lib/whedon/processor.rb:32:innew' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-8e8528b72684/lib/whedon/processor.rb:32:in set_paper' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-8e8528b72684/bin/whedon:52:inprepare' from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.0/lib/thor/command.rb:27:in run' from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.0/lib/thor/invocation.rb:126:ininvoke_command' from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.0/lib/thor.rb:387:in dispatch' from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.0/lib/thor/base.rb:466:instart' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-8e8528b72684/bin/whedon:113:in <top (required)>' from /app/vendor/bundle/ruby/2.4.0/bin/whedon:23:inload' from /app/vendor/bundle/ruby/2.4.0/bin/whedon:23:in `

'

scan2001 commented 6 years ago

@whedon generate pdf

whedon commented 6 years ago 
Attempting PDF compilation. Reticulating splines etc...
whedon commented 6 years ago

:point_right: Check article proof :page_facing_up: :point_left:

scan2001 commented 6 years ago

I'd like to suggest @lmullen as a potential reviewer

lmullen commented 6 years ago

Sorry, I'm not available to review at this time.

arfon commented 5 years ago

:wave: @mgymrek - would you be able to edit this submission for JOSS?

labarba commented 5 years ago

@scan2001 : I had a quick look at your paper, and we are lacking a Statement of Need. That is, we require a paragraph that explains to a technical non-expert what is the research application of the software, and provides an example of how it is being used in research.

The Statement of Need will be requested by reviewers, but if you provide it now, it will facilitate assigning a handling editor and identifying good reviewers for your software.

scan2001 commented 5 years ago

@whedon generate pdf

whedon commented 5 years ago 
Attempting PDF compilation. Reticulating splines etc...
whedon commented 5 years ago

:point_right: Check article proof :page_facing_up: :point_left:

scan2001 commented 5 years ago

@labarba : thank you for your advice. I edited the paper with some sentences about the the research application of the software and the targeted audience.

danielskatz commented 5 years ago

👋 @mgymrek - would you be able to edit this submission for JOSS? (reposting)

danielskatz commented 5 years ago

👋 @mgymrek - ping...

mgymrek commented 5 years ago

@whedon assign @mgymrek as editor

whedon commented 5 years ago

OK, the editor is @mgymrek

mgymrek commented 5 years ago

@zfurnas @masalmon @benmarwick would any of you be able to review this submission?

mgymrek commented 5 years ago

@linuxscout @timClicks @lmullen would any of you be able to review this submission?

mgymrek commented 5 years ago

@linuxscout @timClicks @lmullen @zfurnas @masalmon @benmarwick pinging again to see if any of you would be able to review this one

timClicks commented 5 years ago

@mgymrek Hi Melissa! Sorry, I missed the first notification. I'll be happy to review.

timClicks commented 5 years ago

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.

livioivil commented 5 years ago

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)

Hi, I'm the host of the package. I confirm that I have done a large part of the submissions. However, @scan2001 in most of the cases scripted the first version of the code. So, I think, he deserves the merit of the first authorship. I hope this helps.

mgymrek commented 5 years ago

thanks @timClicks! I am going to move this over to a review thread

mgymrek commented 5 years ago

@whedon assign @timClicks as reviewer

whedon commented 5 years ago

OK, the reviewer is @timClicks

mgymrek commented 5 years ago

@whedon start review

whedon commented 5 years ago

OK, I've started the review over in https://github.com/openjournals/joss-reviews/issues/1256. Feel free to close this issue now!