-
-
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]: Reducing the efforts to create reproducible analysis code with FieldTrip #5566
Comments
Hello humans, I'm @editorialbot, a robot that can help you with some common editorial tasks. 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:
|
|
|
Wordcount for |
Review checklist for @gflofstConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Review checklist for @ashahideConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
@matsvanes does not appear to have made any contributions to this code base. Am I looking at this wrong? |
You seem to be right! Not sure of the expectations for first authorship, but let me check! |
Hi @matsvanes, in response to @gflofst 's comment, do you mind sharing your author's contributions to FieldTrip? Thanks! |
@crsl4 Thanks for reaching out. I can see how my contributions are not clear from FieldTrip's github directly. I hope the following clears things up. Design Development and testing Documentation |
@matsvanes JOSS will have to judge if this is sufficient. I don't have adequate guidance except to see if "significant" effort was involved on the submitter's part. If you have any design notes or otherwise that can be added to this thread, that would make it more easily pass the bar. I appreciate tests and documentation rather than just code. I would certainly count those. Similar software is hard to judge attributions without something explicit. |
Hi @crsl4 - is there any update on the review progress? Thanks! |
Thanks @matsvanes for your message! I am still waiting to hear back from reviewers. The pre-print opens up a new set of questions. Can you explain the overlap? Is that preprint a journal submission? |
@crsl4, We have a question as to whether the submission meets the required significant effort bar. In the submitted materials, the author is not in the code repo at all, but was responsible for writing some of the associated papers, provided after the fact. If this is sufficient, I think we need to have the repo updated with links/copies of the additional materials to be able to check that review criteria as satisfied. I am waiting for your guidance on whether what is in the repo is sufficient, if the additional materials existing are sufficient, if the existing materials need to be added/linked in the repo to be sufficient, or if it is insufficient given the lack of code contributions. |
@crsl4, I was wondering the same thing about the preprint. Should the review comments be focused only on the material in the JOSS article, or should we also consider the additional preprint? Thanks for your help. |
@ashahide We are supposed to only review the JOSS article, but we should understand what is the gap to the pre-print, and whether the pre-print has significant overlap (bc then, why do we have the JOSS article?). |
@gflofst Thanks for your message! I think I want to discuss this with other editors. I am not sure what the standard expectations are compared to other articles. I will reach back, thanks! |
Hi @matsvanes , is there a list of the required Matlab toolboxes somewhere that I may be missing? I see that there is an external folder for additional non-Matlab dependencies and that some of the tests check for necessary toolboxes, but I'm unable to find a list in the documentation. |
Hi @ashahide, the list of external toolboxes can be found here. Most of these are supplied alongside FieldTrip (i.e., in |
I hope I can clarify these questions with some historic perspective/context. |
Let me as the head of the FieldTrip project and senior author on this submission confirm Mats' comment: Mats did indeed make significant contributions to the conceptual design, the implementation, the testing, and the the documentation (initially in the form of a manuscript that was rejected elsewhere, later also on the website). He fully deserves credit for this as first author. My own involvement was mainly to supervise the process, to ensure consistency and future maintainability, and to help with the technical aspects of the coding and merging process. Since we are neuroscientists and neither of us are git and GitHub experts, I realize that the representation on github is not as ideal as it could have been. We continue to constantly learn how to make use of version control using git, and also how to pass those skills on to students that are working on concrete projects which involve coding (like this |
👋 @openjournals/bcm-eics, this paper is ready to be accepted and published. Check final proof 👉📄 Download article If the paper PDF and the deposit XML files look good in openjournals/joss-papers#5020, then you can now move forward with accepting the submission by compiling again with the command |
@editorialbot accept |
I'm sorry @crsl4, I'm afraid I can't do that. That's something only eics are allowed to do. |
@crsl4 thanks for editing this one. Can you please call In particular, the archive title should match the paper title. Also the version tag rendered here should match the one for the archive (it does I think) and should also match a tagged release on their repo (it doesn't I think, I can see the most recent one is
|
@Kevin-Mattheus-Moerman I have checked both points, and updated the reference for BrainLife to the one you provided. |
@Kevin-Mattheus-Moerman do I need to do the post-review checklist again? I already did that before (date Dec 19, 2023), so not sure if it is needed again. |
@crsl4 oh sorry I missed that. No in that case there is no need. Although from my comments you can see several boxes were perhaps ticked but the steps were not completed (e.g. title and version tag), so do keep an eye out for that in the future. |
@editorialbot recommend-accept |
|
|
@matsvanes thanks for making some of these changes. Can you also create a release on your repository with the tag |
👋 @openjournals/bcm-eics, this paper is ready to be accepted and published. Check final proof 👉📄 Download article If the paper PDF and the deposit XML files look good in openjournals/joss-papers#5024, then you can now move forward with accepting the submission by compiling again with the command |
@robertoostenveld Do you have a strong opinion on this? |
We have the release https://github.com/fieldtrip/fieldtrip/releases/tag/20231220, right? That is the release which on Zenodo corresponds to https://doi.org/10.5281/zenodo.10495308. Later tags such as |
@robertoostenveld sorry I missed that. Okay then all is set now, thanks |
@editorialbot accept |
|
Ensure proper citation by uploading a plain text CITATION.cff file to the default branch of your repository. If using GitHub, a Cite this repository menu will appear in the About section, containing both APA and BibTeX formats. When exported to Zotero using a browser plugin, Zotero will automatically create an entry using the information contained in the .cff file. You can copy the contents for your CITATION.cff file here: CITATION.cff
If the repository is not hosted on GitHub, a .cff file can still be uploaded to set your preferred citation. Users will be able to manually copy and paste the citation. |
🐘🐘🐘 👉 Toot 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... |
@matsvanes congratulations on this JOSS publication! Thanks for editing @crsl4 ! And a special thanks to the reviewers: @gflofst, @ashahide !!! |
🎉🎉🎉 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! The 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:
|
Congratulations on the acceptance, and all of your hard work! It was a
pleasure to read.
…On Thu, Feb 22, 2024 at 3:55 PM Kevin Mattheus Moerman < ***@***.***> wrote:
@matsvanes <https://github.com/matsvanes> congratulations on this JOSS
publication!
Thanks for editing @crsl4 <https://github.com/crsl4> ! And a special
thanks to the reviewers: @gflofst <https://github.com/gflofst>, @ashahide
<https://github.com/ashahide> !!!
—
Reply to this email directly, view it on GitHub
<#5566 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AKL5J4HK4M4NTUCMIDWUAJ3YU65E5AVCNFSM6AAAAAAZJN6RPSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNRQGM4DCOBYHE>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
Thank you all for your hard work and the positive outcome! |
Submitting author: @matsvanes (Mats W.J. van Es)
Repository: https://github.com/fieldtrip/fieldtrip
Branch with paper.md (empty if default branch): JOSS
Version: 20231220
Editor: @crsl4
Reviewers: @gflofst, @ashahide
Archive: 10.5281/zenodo.10495308
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 & @ashahide, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review.
First of all you need to run this command in a separate comment to create the checklist:
The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @crsl4 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 ✨
Checklists
📝 Checklist for @gflofst
📝 Checklist for @ashahide
The text was updated successfully, but these errors were encountered: