-
-
Notifications
You must be signed in to change notification settings - Fork 39
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]: cmstatr: An R Package for Statistical Analysis of Composite Material Data #2265
Comments
Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @myousefi2016, @JonasMoss it looks like you're currently assigned to review this paper 🎉. 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:
For a list of things I can do to help you, just type:
For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:
|
|
Thank you @myousefi2016 and @JonasMoss for serving as reviewers for this. Please feel free to reach out to me either through an issue or via email (see my profile) if you have any questions or need any help. |
@kloppen Here is the report! Please don't hesitate to ask for details or make comments! This package is thorough in its documentation and testing and has a clearly laid out reason to exist. I'm impressed by the authors' devotion to showing agreement with CMH-17-1G in almost every function. I deeply appreciate comments such as "The results of this function have been validated against published values in Lawless (1982).", which demonstrates the seriousness of the authors. What's more, it has three vignettes and a unified philosophy. I would have without a doubt used this package if it had been relevant to my work. Not surprisingly, I only found minor issues with this package. Documentation. The documentation is usually strong in explaining what the arguments are there for. But it's often difficult to understand what different functions do. Take
I find it difficult to understand, thus verify, the following functions too. (And this problem is compounded when I don't see an example.)
There might be other functions too with too little of "what does the function do" too. Please be aware that I'm not asking for you to rewrite the documentation (which is good), I just need some more information in some circumstances. In particular, I have to be able to verify if that the exported functions do what they say they do, this is one of the unchecked checkboxes -- and then I have to understand what they are supposed to do. ;)
InstallationCalling
fails when
Paper
I was strongly confused by this passage, and I think it should be reworded or removed. An option is to use only the language of tolerance intervals/bounds, and provide a reference and introduction to their definition and interpretation. Tolerance intervals are too convoluted to properly define in this paper (or the documentation), but they should be referenced by their proper name so that people (that is, people like me! :p) can easily check if they are implemented correctly. Moreover, I suggest to use the terminology "content" and "confidence level" for It is nice that you repeatedly state in the documentation that p = 0.9 and conf = 0.95 corresponds to a B-Basis and so on, you should also state what they are supposed to calculate when p != 0.9 and conf != 0.95. (That is, the lower limits of a one-sided tolerance interval with content p and confidence level 0.95.) A reference for the to me surprising calculations used in e.g.
The rest of the software paper looks fine to me! |
@JonasMoss Thank you very much for your comments. You clearly spent considerable effort in conducting a thorough review of the paper and the package. I really appreciate it! I'll start addressing your comments and will let you know when I'm done. You were quite clear in what you thought should be changed, so I don't anticipate that I'll need any clarification of your comments, but if something comes up, I'll be sure to ask. Thanks again! |
Thanks again for your review and comments, @JonasMoss I've addressed your comments. I've created a separate branch in the https://github.com/ComtekAdvancedStructures/cmstatr/compare/feature/joss-review If you're satisfied with the changes and the responses below, I'll merge the
Documentation
Commit 0b26e1d: I've updated the documentation for both Commit 4042e15: Added URL to documentation for
Commit 92ffa21
Commit 7fdf604
Commit 0b26e1d
Both addressed in commit 0b115ab
These have been added throughout the documentation, as needed.
Commit 685aeb9
Commit ab6b5d0
Commit ffd31d5
Commit cebef8e
Commit 668ee9b
Commit b859093
Commit bc6d412: In the case of the Anderson--Darling tests, I've tried to clear up the terminology, primarily using the term observed significance level, which is the term used by the CMH-17-1G handbook, and also the existing software in use. My understanding is that observed significance level (OSL) is a much less common term that means the same thing as p-value. I agree that calling this p-value, rather than the much less common name observed significance level, would be the more precise terminology, but I do think that there is value in using the terminology that the likely users of this package are accustomed to.
Commit bc6d412. There is a modification, which depends on sample size and distribution, made to the test statistic. This modification is intended to account for the fact that the population parameters are estimated from the sample, rather than known. There are at least two sets of the modifications in the literature.
Commit 668ee9b
Commit 92ffa21
Commit 608a849. This commit also added or improved the examples for the functions:
Installation
Commit 7dc781b addressed this. Installation was verified through fresh install of rocker/rstudio docker container as follows:
Install system dependencies inside docker container:
Then, launch http://localhost:8787 I've confirmed that when Paper
Commit c36c520: The confusing sentence in the paper has been reworked.
I've added a sentence about this in the documentation for the
Commit eac7522: I've added a reference to the Krishnamoorthy book to the documentation for the
I've added a reference to the
I did notice, as I was addressing your comments, that the object returned by |
Thanks, @kloppen! Again, let me say I think this is a very nice package. =) I think everything looks fine now, @usethedata. |
The changes that I made to address JonasMoss' comments were in the I'll re-generate the PDF: I did bump the software version number to I haven't been through the process of publishing in JOSS before, so please let me know what, if anything, I need to do as the author at this point. |
@whedon generate pdf |
@whedon set 0.6.0 as version |
OK. 0.6.0 is the version. |
@whedon check references |
|
@kloppen I've created an issue in your repository with a couple of nits to consider and the next steps in the process: cmstatr/cmstatr#19 |
@whedon generate pdf |
The Zenodo DOI is: 10.5281/zenodo.3930475 I've fixed the couple little nits that you raised on cmstatr/cmstatr#19. I did not change software version number (so, it's still 0.6.0). Please let me know if you need me to do anything else. |
@whedon set 10.5281/zenodo.3930475 as archive |
OK. 10.5281/zenodo.3930475 is the archive. |
@whedon generate pdf |
@whedon check references |
|
@whedon accept |
|
|
👋 @openjournals/joss-eics, this paper is ready to be accepted and published. Check final proof 👉 openjournals/joss-papers#1538 If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#1538, then you can now move forward with accepting the submission by compiling again with the flag
|
@kloppen - I've suggested some small changes to the paper in cmstatr/cmstatr#20 - Once these are made/merged (or you let me know what you disagree with), we can finish the publishing of this work. |
Thanks for your corrections, @danielskatz. I've merged your PR (and then made a subsequent commit to roll those changes into the R-Notebook that generates the paper.md file; that subsequent commit is 923157e). Please let me know if there is anything else I need to do as the author. |
@whedon generate pdf |
@whedon accept |
|
|
👋 @openjournals/joss-eics, this paper is ready to be accepted and published. Check final proof 👉 openjournals/joss-papers#1544 If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#1544, then you can now move forward with accepting the submission by compiling again with the flag
|
@whedon accept deposit=true |
|
🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦 |
🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨 Here's what you must now do:
Any issues? Notify your editorial technical team... |
Thanks to @myousefi2016 & @JonasMoss for reviewing, and @usethedata for editing! Congratulations to @kloppen (Stefan Kloppenborg)!! |
🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉 If you would like to include a link to your paper from your README use the following code snippets:
This is how it will look in your documentation: 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:
|
I'd like to thank @JonasMoss, @myousefi2016, @usethedata and @danielskatz for volunteering their time. I really appreciate it! |
Congratulations! @kloppen 🎊 🎉 |
Submitting author: @kloppen (Stefan Kloppenborg)
Repository: https://github.com/ComtekAdvancedStructures/cmstatr
Version: 0.6.0
Editor: @usethedata
Reviewer: @myousefi2016, @JonasMoss
Archive: 10.5281/zenodo.3930475
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 badge code:
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
@myousefi2016 & @JonasMoss, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:
The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @usethedata know.
✨ Please try and complete your review in the next six weeks ✨
Review checklist for @myousefi2016
Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
Review checklist for @JonasMoss
Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
The text was updated successfully, but these errors were encountered: