Joss-reviews: [REVIEW]: RCaller: A Java package for interfacing R

Created on 6 Oct 2020  ยท  61Comments  ยท  Source: openjournals/joss-reviews

Submitting author: @jbytecode (Mehmet Hakan Satman)
Repository: https://github.com/jbytecode/rcaller/
Version: v3.0.3
Editor: @mikldk
Reviewer: @xin-huang, @nthomasCUBE
Archive: 10.5281/zenodo.4189769

:warning: JOSS reduced service mode :warning:

Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.

Status

status

Status badge code:

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

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) by leaving comments 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

@xin-huang & @nthomasCUBE, 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.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @mikldk know.

โœจ Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest โœจ

Review checklist for @xin-huang

Conflict of interest

  • [x] I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

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] Contribution and authorship: Has the submitting author (@jbytecode) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • [x] Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

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 functionality 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] Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • [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] State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • [x] Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • [x] References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

Review checklist for @nthomasCUBE

Conflict of interest

  • [x] I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

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] Contribution and authorship: Has the submitting author (@jbytecode) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • [x] Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

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 functionality 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] Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • [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] State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • [x] Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • [x] References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?
Java PHP R accepted published recommend-accept review

Most helpful comment

Hi @mikldk I just finished my presentation. I will complete the review by the end of the week. Thanks!

All 61 comments

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @xin-huang, @nthomasCUBE it looks like you're currently assigned to review this paper :tada:.

:warning: JOSS reduced service mode :warning:

Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.

: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 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

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@whedon generate pdf

@whedon generate pdf

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.9734/bjmcs/2014/10902 is OK
- 10.1007/s00180-008-0132-x is OK
- 10.1145/3328433.3328458 is OK

MISSING DOIs

- None

INVALID DOIs

- None

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

@xin-huang, @nthomasCUBE: Thanks for agreeing to review. Please carry out your review in this issue by updating the checklist above and giving feedback in this issue. The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. If possible create issues (and cross-reference) in the submission's repository to avoid too specific discussions in this review thread.

If you have any questions or concerns please let me know.

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

@xin-huang, @nthomasCUBE: I'm just checking in to hear if everything is progressing or is there is anything you need help to?

Hi @mikldk, I am preparing for a conference on 26th. I will finish the review after that.

Hi @mikldk I will try to continue and finish by end of next week

added new issue for updating example in the manuscript
https://github.com/jbytecode/rcaller/issues/43#issuecomment-710939070

i am done with reviewing: seems all use cases worked in Eclipse, great tool

@whedon generate pdf

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

i am done with reviewing: seems all use cases worked in Eclipse, great tool

Dear reviewer @nthomasCUBE , I corrected the example as you mentioned in the issue and the compiled manuscript is above. Thank you for your comment.

i am done with reviewing: seems all use cases worked in Eclipse, great tool

Dear reviewer @nthomasCUBE , I corrected the example as you mentioned in the issue and the compiled manuscript is above. Thank you for your comment.

many thanks!

@xin-huang: What is the status with your review?

Hi @mikldk I just finished my presentation. I will complete the review by the end of the week. Thanks!

The authors implemented an interesting tool for Java programmers to use R codes inside Java, which may be helpful for Java programmers to use tremendous statistical tools in R. However, I feel the authors could improve their documentation and software paper and make them more user-friendly. I have open two issues (https://github.com/jbytecode/rcaller/issues/54 and https://github.com/jbytecode/rcaller/issues/55) in the repo. I hope the authors could address my concerns.
Besides, although the authors did not mention performance in the software paper, they discussed this issue in the manual. Therefore, I suggest the authors release their codes for the benchmark, so that users can verify the performance issue more easily.

@whedon generate pdf

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

Dear reviewer @xin-huang ,

I think I have completed all the changes you suggested. I also made explanations for each of your suggestions in the issues.

Regards.

Hi @mikldk
The authors have addressed my concerns. I have no further comments.

@jbytecode :

  • Please remove "3.0" from title of the paper
  • Please have a final read though of the paper, checking language etc.
  • Have a final check of the proofs with @whedon generate pdf
  • Please make a tagged release and archive (e.g. with Zenodo) as described here, and report the version number and archive DOI in this thread. Please verify that the archive deposit has the correct metadata (title and author list), or edit these if that is not the case.

@whedon generate pdf

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

Dear editor @mikldk ,

  1. The term 3.0 was removed from the title.

2 - 3. The compiled pdf seems to be okay.

  1. The tagged revision is 3.0.3 and the DOI is https://zenodo.org/badge/doi/10.5281/zenodo.4189769.svg - 10.5281/zenodo.4189769

The fetched metadata seems okay.

@whedon set 10.5281/zenodo.4189769 as archive

OK. 10.5281/zenodo.4189769 is the archive.

@whedon set v3.0.3 as version

OK. v3.0.3 is the version.

@whedon generate pdf

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

@whedon check references

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.9734/bjmcs/2014/10902 is OK
- 10.1007/s00180-008-0132-x is OK
- 10.1145/3328433.3328458 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@jbytecode: The metadata at Zenodo is not okay. The title nor the authors match those of the paper. Please check thoroughly. Please also carefully read the paper and verify that everything is in order and confirm.

Dear editor @mikldk

  • I corrected the authors list and the title in Zenodo.

  • I made a small correction in the summary, have you got any suggestions for me to correct anything else? It is okay to me.

@whedon generate pdf

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

@whedon accept

Attempting dry run of processing paper acceptance...
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.9734/bjmcs/2014/10902 is OK
- 10.1007/s00180-008-0132-x is OK
- 10.1145/3328433.3328458 is OK

MISSING DOIs

- None

INVALID DOIs

- None

:wave: @openjournals/joss-eics, this paper is ready to be accepted and published.

Check final proof :point_right: https://github.com/openjournals/joss-papers/pull/1891

If the paper PDF and Crossref deposit XML look good in https://github.com/openjournals/joss-papers/pull/1891, then you can now move forward with accepting the submission by compiling again with the flag deposit=true e.g.
@whedon accept deposit=true

@jbytecode I'm helping to process the last steps for this paper. It looks like the paper needs a bit of work to improve language. Can you please consider the points below.

@mikldk could you also help review the paper, since R/Java are not my expertise I want to make sure I did not misunderstood anything.

  • [x] Please add (city and) country information to all affiliations

  • [x] Please review this sentence: "Addition to the previous revisions, RCaller 3.0 implements the scripting API of Java in which the R function calls and data transfers are performed in a standard way as in the way of calling other scripting languages in Java.", it does not read well and the "Addition" part seems incorrect. Consider rephrasing to (if I understood it correctly): "Unlike previous RCaller versions, RCaller 3.0 implements the scripting API of Java, ensuring R function calls and data transfers are performed in a standard way, as is usual for other scripting languages in Java."

  • [x] Check this sentence (use in instead of on): "Nowadays, the interest on in statistical computation and data analysis increased the popularity of some programming languages such as R, Python, and Julia.", also it sounds a bit awkward, would this be better: "Nowadays, increased interest in statistical computation and data analysis has enhanced the popularity of some programming languages such as R, Python, and Julia."

  • [x] Please rephrase this sentence: " On the other side, many main frame languages are adopted for more specific tasks in server-side or the general-purpose use in several platforms."

  • [x] Check this sentence "These huge collection of computation tools are not directly accessible...", it looks like it should probably read "This huge collection of computation tools is not directly accessible..."

  • [x] Rephrase this sentence (perhaps it needs commas): "Previous works showed that the performance of the library is suitable for more cases and studies with moderate data sets can be handled in reasonable times"

  • [x] Consider rephrasing "After being introduced in paper.... are implemented besides ", to something like "Following its first publication.... have been implemented, as well as,... "

  • [x] Suggestion: "matured" -> "mature"

  • [x] Add comma/rephrase: "...and function optimization besides other research tools" -> "...and function optimization, as well as other research tools". Also, if you were to say: "R has many well-tested and mature packages, [including] for...", then you could leave "as well as other research tools" out which sounds less vague.

  • [x] Suggestion "....that R serves... " -> "....that R provides... "

  • [x] "free microservice solution" -> "a free microservice solution".

Dear editor @Kevin-Mattheus-Moerman

Thank you very much for your effort on correcting language. I made the corrections as suggested above. However, in (2) it is not "unlike" but a "new feature" so other kinds of calling schemes are still current. I changed it to

In addition to previous RCaller versions, RCaller 3.0 implements the scripting API of Java, ensuring R function calls and data transfers are performed in a standard way, as is usual for other scripting languages in Java.

Regards.

@whedon generate pdf

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

@jbytecode I ticked some of the boxes. Some points still remaining. @mikldk can you check some of these sentences and perhaps shed light on how best to rephrase them?

Dear editor @Kevin-Mattheus-Moerman ,

Sorry to take your precious time for language corrections. Here is my effort to correct unchecked suggestions:

@whedon generate pdf

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

@Kevin-Mattheus-Moerman, thanks for catching these. Below you will find my comments to the unchecked boxes:

  • [x] Please rephrase this sentence: " On the other side, many main frame languages are adopted for more specific tasks in server-side or the general-purpose use in several platforms."

    • Change main frame to mainframe (?) and rephrasing to improve understanding; maybe include the term domain-specific language
  • [x] Check this sentence "These huge collection of computation tools are not directly accessible...", it looks like it should probably read "This huge collection of computation tools is not directly accessible..."

    • Already fixed from what I can see.
  • [x] Add comma/rephrase: "...and function optimization besides other research tools" -> "...and function optimization, as well as other research tools". Also, if you were to say: "R has many well-tested and mature packages, [including] for...", then you could leave "as well as other research tools" out which sounds less vague.

    • Already fixed from what I can see.

Dear editor @mikldk,

The term domain-specific is a little bit a 'constricted concept', like SQL, however I corrected main frame to mainframe

@whedon generate pdf

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

@whedon accept deposit=true

Doing it live! Attempting automated processing of paper acceptance...

๐Ÿฆ๐Ÿฆ๐Ÿฆ ๐Ÿ‘‰ Tweet for this paper ๐Ÿ‘ˆ ๐Ÿฆ๐Ÿฆ๐Ÿฆ

๐Ÿšจ๐Ÿšจ๐Ÿšจ THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! ๐Ÿšจ๐Ÿšจ๐Ÿšจ

Here's what you must now do:

  1. Check final PDF and Crossref metadata that was deposited :point_right: https://github.com/openjournals/joss-papers/pull/1903
  2. Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/joss.02722
  3. If everything looks good, then close this review issue.
  4. Party like you just published a paper! ๐ŸŽ‰๐ŸŒˆ๐Ÿฆ„๐Ÿ’ƒ๐Ÿ‘ป๐Ÿค˜

    Any issues? Notify your editorial technical team...

I would like to thank everyone who contributed to the editorial process. It was a great experience to have an article published on JOSS.

All the best.

@Kevin-Mattheus-Moerman @mikldk @xin-huang @nthomasCUBE @Kopilov

@xin-huang, @nthomasCUBE - many thanks for your reviews here and to @mikldk for editing this submission โœจ

@jbytecode - your paper is now accepted and published in JOSS :zap::rocket::boom:

: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 snippets:

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

HTML:
<a style="border-width:0" href="https://doi.org/10.21105/joss.02722">
  <img src="https://joss.theoj.org/papers/10.21105/joss.02722/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: https://joss.theoj.org/papers/10.21105/joss.02722/status.svg
   :target: https://doi.org/10.21105/joss.02722

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:

Was this page helpful?
0 / 5 - 0 ratings