Joss-reviews: [PRE REVIEW]: insight: Easy Access to Model Information for Various Model Objects

[whedon]

Submitting author: @strengejacke (Daniel Lüdecke)
Repository: https://github.com/easystats/insight
Version: 0.2.1
Editor: @karthik
Reviewers: @alexpghayes

Author instructions

Thanks for submitting your paper to JOSS @strengejacke. The JOSS editor @alexhanna, will work with you on this issue to find a reviewer for your submission before creating the main review issue.

@strengejacke 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]

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @alexhanna it looks like you're currently assigned as the editor for this paper :tada:

For a list of things I can do to help you, just type:

@whedon commands

What happens now?

This submission is currently in a pre-review state which means we are waiting for the assigned editor (@alexhanna) to find some reviewers for your submission. This may take anything between a few hours to a couple of weeks. Thanks for your patience :smile_cat:

You can help the editor by looking at this list of potential reviewers to identify individuals who might be able to review your submission (please start at the bottom of the list). Also, feel free to suggest individuals who are not on this list by mentioning their GitHub handles here.

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

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

/app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-a1723d160bb6/lib/whedon.rb:83:in check_fields': Paper YAML header is missing expected fields: bibliography (RuntimeError) from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-a1723d160bb6/lib/whedon.rb:69:ininitialize'
from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-a1723d160bb6/lib/whedon/processor.rb:32:in new' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-a1723d160bb6/lib/whedon/processor.rb:32:inset_paper'
from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-a1723d160bb6/bin/whedon:55:in prepare' from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/command.rb:27:inrun'
from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/invocation.rb:126:in invoke_command' from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor.rb:387:indispatch'
from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/base.rb:466:in start' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-a1723d160bb6/bin/whedon:116:in from /app/vendor/bundle/ruby/2.4.0/bin/whedon:23:in load' from /app/vendor/bundle/ruby/2.4.0/bin/whedon:23:in

'

[danielskatz]

👋 @alexhanna - this submission suggested you as the editor - is this ok with you?

[danielskatz]

@strengejacke - I don't see a paper.bib file in your repo - please see https://joss.readthedocs.io/en/latest/submitting.html#example-paper-and-bibliography for an example of how the paper.md and paper.bib work together

[strengejacke]

Thanks @danielskatz for starting the pre-review. Actually, the package is more "technical" and does not implement methods proposed in (statistical) papers... That's why we haven't included a bibliography. If it's required, we could at least cite the R-software, if this is OK for you?

[danielskatz]

yes, please do - it seems that we expect something ...

[strengejacke]

Ok, bibliography added.
Suggested reviewers, with no preferred order:

@amoeba
@cschwem2er
@Ohlsen
@jsta
@corybrunson

[danielskatz]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

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

[danielskatz]

Ok, it looks like you don't actually have to cite anything, but you do need a paper.bib file.
If you want to cite R, you will need to put a reference to it in the paper.md file - see the example for how to do this. If not, I guess it's fine, but it's a bit odd to have a paper about research software that has no citations of previous work. The reviewers can discuss this issue...
(If you do make changes, you can regenerate the PDF by adding a new comment here containing @whedon generate pdf)

[strengejacke]

I have cited R in the appropriate place, but indeed I forgot a _References_ heading at the end...

[strengejacke]

I will also discuss with the co-authors if and where it makes sense to add references.

[strengejacke]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

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

[alexhanna]

@danielskatz -- I'm not sure I'm the best editor for this, but will handle it if there's no better fit.

[danielskatz]

👋 @karthik - would you be willing to edit this instead?

[karthik]

Sure I can.

[danielskatz]

@whedon assign @karthik as editor

[whedon]

OK, the editor is @karthik

[karthik]

@whedon assign @alexpghayes as reviewer

[whedon]

OK, the reviewer is @alexpghayes

[karthik]

@whedon start review

[whedon]

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