Skip to content
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]: The stantargets R package: a workflow framework for efficient reproducible Stan-powered Bayesian data analysis pipelines #3193

Closed
20 tasks done
whedon opened this issue Apr 19, 2021 · 25 comments
Assignees
Labels
accepted published Papers published in JOSS R recommend-accept Papers recommended for acceptance in JOSS. review rOpenSci Submissions associated with rOpenSci Stan TeX

Comments

@whedon
Copy link

whedon commented Apr 19, 2021

Submitting author: @wlandau (William Landau)
Repository: /~https://github.com/ropensci/stantargets
Version: 0.0.0.9003
Editor: @kyleniemeyer
Reviewer: @kyleniemeyer
Archive: 10.5281/zenodo.4706113

⚠️ JOSS reduced service mode ⚠️

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/cef9615fa06bea5e0432afe33ac051e0"><img src="https://joss.theoj.org/papers/cef9615fa06bea5e0432afe33ac051e0/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/cef9615fa06bea5e0432afe33ac051e0/status.svg)](https://joss.theoj.org/papers/cef9615fa06bea5e0432afe33ac051e0)

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

@kyleniemeyer, 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 @kyleniemeyer 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 @kyleniemeyer

Conflict of interest

  • 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

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

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

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Does the paper have a section titled 'Statement of Need' that clearly states what problems the software is designed to solve and who the target audience is?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • 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?
@whedon
Copy link
Author

whedon commented Apr 19, 2021

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @kyleniemeyer it looks like you're currently assigned to review this paper 🎉.

⚠️ JOSS reduced service mode ⚠️

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.

⭐ 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

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

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Apr 19, 2021

Software report (experimental):

github.com/AlDanial/cloc v 1.88  T=0.24 s (327.2 files/s, 53720.5 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
R                               54             90           1434           8226
SVG                              2              0              0            810
Rmd                              3            126            210            520
Markdown                        10             92              0            353
JSON                             1              0              0            307
YAML                             5             41             64            255
TeX                              2             11              0            104
-------------------------------------------------------------------------------
SUM:                            77            360           1708          10575
-------------------------------------------------------------------------------


Statistical information for the repository 'a0b9e3e7311d217955e2ca1b' was
gathered on 2021/04/19.
No commited files with the specified extensions were found.

@whedon
Copy link
Author

whedon commented Apr 19, 2021

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@whedon
Copy link
Author

whedon commented Apr 19, 2021

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

OK DOIs

- 10.21105/joss.02959 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@kyleniemeyer
Copy link

For reference: this submission was already reviewed and accepted by rOpenSci ropensci/software-review#430

@kyleniemeyer
Copy link

Hi @wlandau, I just noticed a few minor issues with some references, it looks like some need additional information or different formatting. In particular, the Cndstanr and Stantargets citations should both include a URL or DOI (if one exists), and both should have years (e.g., for the latest version, if you aren't citing a particular version).

wlandau-lilly added a commit to ropensci/stantargets that referenced this issue Apr 20, 2021
@wlandau
Copy link

wlandau commented Apr 20, 2021

Thanks @kyleniemeyer, should be fixed in ropensci/stantargets@1f9b58f.

@kyleniemeyer
Copy link

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Apr 20, 2021

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@kyleniemeyer
Copy link

@wlandau looks good! Please now archive the software repository (e.g., on Zenodo) and report the DOI here, and then I will accept this.

@wlandau
Copy link

wlandau commented Apr 20, 2021

I created a release with DOI https://doi.org/10.5281/zenodo.4706113. Looks to be still pending.

@kyleniemeyer
Copy link

@whedon set 10.5281/zenodo.4706113 as archive

@wlandau works now! Before I publish, can you just clean up the author list of that? It looks to have you listed twice.

@whedon
Copy link
Author

whedon commented Apr 21, 2021

OK. 10.5281/zenodo.4706113 is the archive.

@wlandau
Copy link

wlandau commented Apr 21, 2021

Thanks, I removed the duplicate author entry.

@kyleniemeyer
Copy link

@whedon accept

@whedon
Copy link
Author

whedon commented Apr 21, 2021

Attempting dry run of processing paper acceptance...

@whedon whedon added the recommend-accept Papers recommended for acceptance in JOSS. label Apr 21, 2021
@whedon
Copy link
Author

whedon commented Apr 21, 2021

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

OK DOIs

- 10.21105/joss.02959 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Apr 21, 2021

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

Check final proof 👉 openjournals/joss-papers#2251

If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#2251, then you can now move forward with accepting the submission by compiling again with the flag deposit=true e.g.

@whedon accept deposit=true

@kyleniemeyer
Copy link

@whedon accept deposit=true

@whedon
Copy link
Author

whedon commented Apr 21, 2021

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

@whedon whedon added the published Papers published in JOSS label Apr 21, 2021
@whedon
Copy link
Author

whedon commented Apr 21, 2021

🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦

@whedon
Copy link
Author

whedon commented Apr 21, 2021

🚨🚨🚨 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 👉 Creating pull request for 10.21105.joss.03193 joss-papers#2252
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.03193
  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...

@kyleniemeyer
Copy link

Congratulations @wlandau on your article's publication in JOSS!

@arfon arfon closed this as completed Apr 21, 2021
@whedon
Copy link
Author

whedon commented Apr 21, 2021

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

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

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

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

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:

@wlandau
Copy link

wlandau commented Apr 21, 2021

Thanks so much, @kyleniemeyer!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted published Papers published in JOSS R recommend-accept Papers recommended for acceptance in JOSS. review rOpenSci Submissions associated with rOpenSci Stan TeX
Projects
None yet
Development

No branches or pull requests

4 participants