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]: ggeffects - Tidy Data Frames of Marginal Effects from Regression Models #772

Closed
whedon opened this Issue Jun 11, 2018 · 18 comments

Comments

Projects
None yet
5 participants
@whedon
Collaborator

whedon commented Jun 11, 2018

Submitting author: @strengejacke (Daniel Lüdecke)
Repository: https://github.com/strengejacke/ggeffects
Version: 0.3.4
Editor: @leeper
Reviewer: @cdcrabtree
Archive: 10.5281/zenodo.1301148

Status

status

Status badge code:

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

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

@cdcrabtree, 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 @leeper know.

Review checklist for @cdcrabtree

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 (0.3.4)?
  • Authorship: Has the submitting author (@strengejacke) 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

This comment has been minimized.

Collaborator

whedon commented Jun 11, 2018

Hello human, I'm @whedon. I'm here to help you with some common editorial tasks. @cdcrabtree 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.

Collaborator

whedon commented Jun 11, 2018

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

This comment has been minimized.

Collaborator

whedon commented Jun 11, 2018

@leeper

This comment has been minimized.

Member

leeper commented Jun 11, 2018

@cdcrabtree Here's the review issue. Please work through the review checklist, open issues on the source repo for any issues not addressed by the checklist or that you'd like to see changed, then send me a message here when you'd like me to have a look.

@strengejacke

This comment has been minimized.

Collaborator

strengejacke commented Jun 14, 2018

Is it possible to get a template for compiling the PDF? I would like to add a page break to layout the figures in the paper, and don't want to spam this thread with try&error-submission for my paper.md to check when the PDF looks best... So I want to check this locally. Or is there a kind of "typesetting" before publishing once a paper is accepted?

@arfon

This comment has been minimized.

Member

arfon commented Jun 15, 2018

Some of our authors have used this Dockerfile in the past: https://github.com/greatfireball/docker_whedon_translate4joss . The tmp/whedon referred to here is https://github.com/openjournals/whedon

Not sure if this helps you?

@strengejacke

This comment has been minimized.

Collaborator

strengejacke commented Jun 23, 2018

@whedon generate pdf

Ok, I hope I have the layout right now...

@whedon

This comment has been minimized.

Collaborator

whedon commented Jun 23, 2018

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

This comment has been minimized.

Collaborator

whedon commented Jun 23, 2018

@cdcrabtree

This comment has been minimized.

Collaborator

cdcrabtree commented Jun 29, 2018

@leeper I've finished my review. Everything looks great here.

@strengejacke

This comment has been minimized.

Collaborator

strengejacke commented Jun 29, 2018

Thanks, Charles, for reviewing my submission! I have created a new release that includes all reviewer suggestions and created a doi for this version, which can be used for the submitted paper:

https://doi.org/10.5281/zenodo.1301148

@leeper

This comment has been minimized.

Member

leeper commented Jun 29, 2018

@whedon set 10.5281/zenodo.1301148 as archive

@whedon

This comment has been minimized.

Collaborator

whedon commented Jun 29, 2018

OK. 10.5281/zenodo.1301148 is the archive.

@leeper

This comment has been minimized.

Member

leeper commented Jun 29, 2018

@cdcrabtree Thank you very much for the quick review!

@leeper

This comment has been minimized.

Member

leeper commented Jun 29, 2018

@arfon Over to you.

@arfon arfon added the accepted label Jun 29, 2018

@arfon

This comment has been minimized.

Member

arfon commented Jun 29, 2018

@cdcrabtree - many thanks for your review here and to @leeper for editing this submission

@strengejacke - your paper is now accepted into JOSS and your DOI is http://joss.theoj.org/papers/10.21105/joss.00772 ⚡️ 🚀 💥

@arfon arfon closed this Jun 29, 2018

@whedon

This comment has been minimized.

Collaborator

whedon commented Jun 29, 2018

🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉

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

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:

@strengejacke

This comment has been minimized.

Collaborator

strengejacke commented Jun 29, 2018

Thanks a lot to all of you - including whedon ;-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment