-
-
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]: Science Capsule - Capturing the Data Life Cycle #2484
Comments
Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @cmbiwer 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:
|
|
👋🏼 @dghoshal-lbl @colbrydi @cmbiwer this is the review thread for the paper. All of our communications will happen here from now on. Both reviewers have checklists at the top of this thread with the JOSS requirements. As you go over the submission, please check any items that you feel have been satisfied. There are also links to the JOSS reviewer guidelines. The JOSS review is different from most other journals. Our goal is to work with the authors to help them meet our criteria instead of merely passing judgment on the submission. As such, the reviewers are encouraged to submit issues and pull requests on the software repository. When doing so, please mention We aim for reviews to be completed within about 6 weeks. Please let me know if any of you require some more time. We can also use Whedon (our bot) to set automatic reminders if you know you'll be away for a known period of time. Please feel free to ping me (@pibion) if you have any questions/concerns. |
OK, @colbrydi is now a reviewer |
👋🏼 @dghoshal-lbl @colbrydi @cmbiwer, I'm just checking in on when you expect to be able to begin taking a look at this repository and the reviewer checklist. If you know you won't be able to start until a particular date, we can set a timer to remind you to take a look at the review. |
I'll begin looking at it within a week. |
@cmbiwer thanks for the update! |
Hi, I think I need a new invitation. When I try to accept the invitation I get:
EDIT: I am logged in. |
@cmbiwer the only thing you need to be able to do for the review is post on this thread. Some reviewers do contribute to the code in the actual software repository, but until you want to do that non-write public access should be all you need. Does this help? |
Here are some notes from my review: Science Capsule allows the capturing of Command line activities inside a user specified working directory. These activities include file systems events (using inotify) and process events (using strace) using the python watchdog module. The results can be monitored using a live web interface. The captured information is intended to help identify artifacts of a scientific work flow process that are not always captured using traditional computational workflows. This information is intended to help improve documentation of research data methodology and curation (aka data provenance) that may be lost without such a monitoring system. Overall I am very pleased with the software, it performed nicely. It did not seem to take up too much of my local resources and the web interface was fairly straightforward. The code seems to be well written and I have ideas on how I may use this tool in my own projects. Great job! That being said, the documentation was probably the weakest aspect of the submission. Both the repository readme file and the JOSS paper do not do a good enough job explaining what the software is doing or why it is needed. The paper uses an overly general statement "Science Capsule captures, organizes, and manages the end-to-end scientific process to facilitate capture of provenance," This sounds good but is extremely vague and I feel overstates the roll of the software. I think these documents would be significantly improved if a few concrete example cases for the software use are included. Without these examples I feel many readers would not know why they would want to install and use the software. I worry that many system administrators that are not researchers will not see the benefit of the software and many scientists that could use the software will not understand what it can (and can't) do (i.e. it's not a a magic wand but it is a fairly useful tool). Should the software be run locally or run on a large system? What does it do well and where might it need work? I was able to download install The python testing suite was straightforward and all tests ran successfully. There was some additional "testing" procedures to verify that the software is working. Mostly these tests involve making a directory and reviewing the results. Seems reasonable and seems to work. Below are a few more of my notes using the Joss Review Checklist Review checklistConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
@pibion Okay thanks. I wasn't sure if it was needed to fill out the checklist in the first post. Though, I can post it all here as the previous post. |
Here are my notes below. Science Capsule is a tool to capture the command line and state of directories with information such as new or deleted files. There is a HTML viewer that organizes this information for the user. These capabilities in Science Capsule have been designed to facilitate the reproduction of analyses and sharing results. The strengths of this submission are its walkthrough documentation and implementation. I believe the software functionality does what it intends. Its README instructions were well-written to get the user started quickly. There are tests which seem to capture the core functionality and were easy to execute. The full instructions do require some tools such as Docker, so some familiarity with those would be required for those sections in the instructions. However, the bare metal instructions are easy to follow for a novice user. And therefore, the tool should be widely accessible to new users that do not have much experience with these types of tools. I think the one major weakness is the summary of the software itself in the paper and documentation. Citations and the state of the field are omitted. I can see the usefulness of capturing this information, but I do not think the introduction of the paper clearly states the state of the field, how Science Capsule is unique, and why the user would want this information that Science Capsule captures. It would have been nice to see a description about what exactly Science Capsule is doing under the hood—either in the documentation or paper. The documentation is more of a walkthrough and not really any documentation of the code itself. There are several key features listed at the end that really highlight what the user wants to know. I would have liked to see explanation of these features expanded and emphasized in the text. A real-world example of a problem Science Capsule helps solve would really improve its motivation as well. There was also a bold claim at the start that DOE is at risk of unusable data. How is it unusable due to the complexity and processing of the data? What is meant by complexity? And how does Science Capsule make it useable? This statement was not very clear to me. Overall, I think the authors have provided excellent instructions and designed a tool that matches their key features they list in the paper. I see nothing wrong with Science Capsule itself. It has a unique functionality that I can see how it would be useful. However, the documentation/paper could be strengthened since the motivation and summary in the paper are vague and perhaps too high-level. Review checklist |
@cmbiwer thanks for these comments! |
@dghoshal-lbl, it sounds like most of the technical aspects of your software (installation, tests, usage) already meet JOSS standards for publication. The most important thing to address is the "statement of need" as that's critical in determining whether software is within the scope of JOSS. I'll let the reviewers comment for themselves; @colbrydi says that the package might be useful in his scientific work, which seems like a point in favor. |
Thanks @dghoshal-lbl ! |
@dghoshal-lbl just wanted to check in on the status of this. No pressure, just saying hello. |
@pibion Sorry for the delay. Had too many deadlines in the last few weeks. We are working on fixing the documentation and paper. I will let you know once everything has been updated. |
To recommend a paper to be accepted use |
@whedon recommend-accept |
|
|
Sorry - I forgot that had changed... |
👋 @openjournals/joss-eics, this paper is ready to be accepted and published. Check final proof 👉 openjournals/joss-papers#2397 If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#2397, then you can now move forward with accepting the submission by compiling again with the flag
|
@openjournals/joss-eics this paper is ready for its final review! |
@dghoshal-lbl - Do you want to update the title metadata in the Zenodo archive to match the paper title? It's not required, but it's usual for JOSS submissions and archives |
@danielskatz This time I intentionally kept the title metadata in Zenodo as the name of the software since the archive is for the software :). But I think it would be good to match it with the JOSS paper title. I will change that. |
Done! |
@dghoshal-lbl - I've also found a few things in the paper while proofreading it - see https://bitbucket.org/sciencecapsule/sciencecapsule/pull-requests/54 |
Let me know if this doesn't look right - I'm not really used to bitbucket PRs, so it's possible I've done something wrong |
@danielskatz Thanks for the proofread and the fixes! I have merged your changes and also fixed a missing citation. Let me know if everything looks good and I will update the Zenodo archive. |
@whedon check references |
@whedon generate pdf |
|
This looks good to me - if you want to update the archive, that's fine, though it's not required. Let me know either way, and I'll optionally update the archive address, and then finish the publishing of the paper |
If it's not required then it should be good to go. Thanks! |
@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... |
Congratulations to @dghoshal-lbl (Devarshi Ghoshal) and co-authors!! And thanks to @colbrydi, @gflofst, and @atrisovic for reviewing, and @pibion for editing! |
🎉🎉🎉 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:
|
Submitting author: @dghoshal-lbl (Devarshi Ghoshal)
Repository: https://bitbucket.org/sciencecapsule/sciencecapsule
Version: v0.1.1
Editor: @pibion
Reviewers: @colbrydi, @gflofst, @atrisovic
Archive: 10.5281/zenodo.4968576
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
@gflofst, 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 @pibion 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 @atrisovic
Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
Review checklist for @gflofst
Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
Review checklist for @colbrydi
Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
The text was updated successfully, but these errors were encountered: