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]: EduCortex: browser-based 3D brain visualization of fMRI meta-analysis maps #75

Closed
40 of 54 tasks
whedon opened this issue Feb 5, 2020 · 45 comments
Closed
40 of 54 tasks
Assignees
Labels
accepted published Papers published in JOSE recommend-accept Papers recommended for acceptance in JOSE. review

Comments

@whedon
Copy link
Collaborator

whedon commented Feb 5, 2020

Submitting author: @PaulScotti (Paul Scotti)
Repository: https://github.com/PaulScotti/EduCortex
Version: v1.1
Editor: @magsol
Reviewers: @tliu23, @TomDonoghue
Archive: 10.5281/zenodo.3732375

Status

status

Status badge code:

HTML: <a href="https://jose.theoj.org/papers/9c6a6a00a0c2d68f1e896de9e59471ea"><img src="https://jose.theoj.org/papers/9c6a6a00a0c2d68f1e896de9e59471ea/status.svg"></a>
Markdown: [![status](https://jose.theoj.org/papers/9c6a6a00a0c2d68f1e896de9e59471ea/status.svg)](https://jose.theoj.org/papers/9c6a6a00a0c2d68f1e896de9e59471ea)

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

@tliu23 & @TomDonoghue & @arokem, 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 @magsol know.

Please try and complete your review in the next two weeks

Review checklist for @tliu23

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: v1.1
  • Authorship: Has the submitting author (@PaulScotti) made substantial 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? (and documentation is sufficient?)
  • 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 the need for this software 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?
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • 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 the need for this software and who the target audience is?
  • References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?

Review checklist for @TomDonoghue

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: v1.1
  • Authorship: Has the submitting author (@PaulScotti) made substantial 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? (and documentation is sufficient?)
  • 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 the need for this software 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?
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • 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 the need for this software and who the target audience is?
  • References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?

Review checklist for @arokem

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: v1.1
  • Authorship: Has the submitting author (@PaulScotti) made substantial 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? (and documentation is sufficient?)
  • 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 the need for this software 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?
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • 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 the need for this software and who the target audience is?
  • References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?
@whedon
Copy link
Collaborator Author

whedon commented Feb 5, 2020

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

Important

If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/openjournals/jose-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/jose-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
Collaborator Author

whedon commented Feb 5, 2020

@whedon
Copy link
Collaborator Author

whedon commented Feb 5, 2020

Reference check summary:

OK DOIs

- None

MISSING DOIs

- https://doi.org/10.3389/fninf.2015.00023 may be missing for title: Pycortex: an interactive surface visualizer for fMRI
- https://doi.org/10.1016/s1364-6613(03)00134-7 may be missing for title: The visual word form area: expertise for reading in the fusiform gyrus

INVALID DOIs

- None

@magsol
Copy link

magsol commented Feb 12, 2020

Hi @TomDonoghue and @tliu23, wanted to check in on how the review is going and see if there was anything you needed!

@TomDonoghue
Copy link
Collaborator

Sorry for being a little slow - had a busy week last week - but should be able to do the review in the next couple days, and don't think I need anything in particular for now! Thanks!

@magsol
Copy link

magsol commented Mar 3, 2020

Hi @TomDonoghue and @tliu23, I'd really like to wrap this review up soon. Please let me know if you need anything in the meantime. Thanks!

@tliu23 tliu23 closed this as completed Mar 4, 2020
@tliu23 tliu23 reopened this Mar 4, 2020
@tliu23
Copy link
Collaborator

tliu23 commented Mar 4, 2020

Went through the lists and checked the ones.

@tliu23 tliu23 closed this as completed Mar 4, 2020
@tliu23
Copy link
Collaborator

tliu23 commented Mar 4, 2020 via email

@magsol magsol reopened this Mar 4, 2020
@magsol
Copy link

magsol commented Mar 4, 2020

Thanks @tliu23, let me know when you think you can check off the last couple items.

@tliu23 tliu23 closed this as completed Mar 4, 2020
@tliu23
Copy link
Collaborator

tliu23 commented Mar 4, 2020

Done, thanks.

@tliu23
Copy link
Collaborator

tliu23 commented Mar 4, 2020 via email

@magsol magsol reopened this Mar 4, 2020
@magsol
Copy link

magsol commented Mar 4, 2020

Awesome, thanks @tliu23. Did you have any final comments for the authors?

@tliu23
Copy link
Collaborator

tliu23 commented Mar 4, 2020 via email

@magsol
Copy link

magsol commented Mar 4, 2020

Great, thanks.

@TomDonoghue, let me know when you'd be able to get to the review. Would love to wrap this up soon.

@TomDonoghue
Copy link
Collaborator

TomDonoghue commented Mar 4, 2020

@magsol : I'm very sorry for the delay - I will get to this today!

Edit: been working through the project (looks super cool), will consolidate my thoughts and post comments and finish review soon.

@whedon whedon assigned magsol and unassigned TomDonoghue and tliu23 Mar 28, 2020
@whedon
Copy link
Collaborator Author

whedon commented Mar 28, 2020

OK, @arokem is no longer a reviewer

@magsol
Copy link

magsol commented Mar 28, 2020

@whedon generate pdf

@whedon
Copy link
Collaborator Author

whedon commented Mar 28, 2020

@magsol
Copy link

magsol commented Mar 28, 2020

Sorry for the delay--university changes around COVID-19 have upended my schedule from its roots, though I'm sure I don't have to explain that to anyone here.

Thanks @tliu23 and @TomDonoghue for your reviews, and especially Tom for the insightful comments and feedback. This was a lot of fun to read, and super awesome that this came out of Neurohackademy; it's such a phenomenal annual workshop/meeting.

To finalize EduCortex for publication, @PaulScotti I need you to make a tagged release & archive of the artifact. Once that's done, report version number and DOI in this thread, and we can take it from there.

@PaulScotti
Copy link
Collaborator

v1.1: https://github.com/PaulScotti/educortex/releases/tag/v1.1
archive: https://doi.org/10.5281/zenodo.3732375

Huge thanks to @magsol @TomDonoghue and @tliu23 for their time and effort spent facilitating this review process, I'm very thankful that this journal exists to support projects like this.

@magsol
Copy link

magsol commented Mar 30, 2020

@whedon set 10.5281/zenodo.3732375 as archive

@whedon
Copy link
Collaborator Author

whedon commented Mar 30, 2020

OK. 10.5281/zenodo.3732375 is the archive.

@magsol
Copy link

magsol commented Mar 30, 2020

@whedon set v1.1 as version

@whedon
Copy link
Collaborator Author

whedon commented Mar 30, 2020

OK. v1.1 is the version.

@magsol
Copy link

magsol commented Mar 30, 2020

@whedon accept

@whedon whedon added the recommend-accept Papers recommended for acceptance in JOSE. label Mar 30, 2020
@whedon
Copy link
Collaborator Author

whedon commented Mar 30, 2020

Attempting dry run of processing paper acceptance...

@whedon
Copy link
Collaborator Author

whedon commented Mar 30, 2020

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

Check final proof 👉 openjournals/jose-papers#47

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

@whedon accept deposit=true

@magsol
Copy link

magsol commented Apr 3, 2020

Hi @openjournals/jose-eics , whenever you get a chance, please give @PaulScotti 's submission here a final yay/nay!

@labarba
Copy link
Member

labarba commented Apr 4, 2020

@PaulScotti — Could you edit the metadata of the Zenodo deposit so the title and author list matches the paper? Thanks!

@PaulScotti
Copy link
Collaborator

@labarba I corrected the author names/affiliations and the title of the Zenodo deposit, are there other metadata that I should correct?

@labarba
Copy link
Member

labarba commented Apr 4, 2020

@whedon accept deposit=true

@whedon
Copy link
Collaborator Author

whedon commented Apr 4, 2020

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

@whedon whedon added accepted published Papers published in JOSE labels Apr 4, 2020
@whedon
Copy link
Collaborator Author

whedon commented Apr 4, 2020

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSE! 🚨🚨🚨

Here's what you must now do:

  1. Check final PDF and Crossref metadata that was deposited 👉 Creating pull request for 10.21105.jose.00075 jose-papers#48
  2. Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/jose.00075
  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...

@labarba
Copy link
Member

labarba commented Apr 4, 2020

Congratulations, @PaulScotti, your JOSE paper is published! 🚀

Huge thanks to our editor: @magsol, and the reviewers: @tliu23, @TomDonoghue — we couldn't do this without you 🙏

@labarba
Copy link
Member

labarba commented Apr 4, 2020

@labarba labarba closed this as completed Apr 4, 2020
@whedon
Copy link
Collaborator Author

whedon commented Apr 4, 2020

🎉🎉🎉 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://jose.theoj.org/papers/10.21105/jose.00075/status.svg)](https://doi.org/10.21105/jose.00075)

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

reStructuredText:
.. image:: https://jose.theoj.org/papers/10.21105/jose.00075/status.svg
   :target: https://doi.org/10.21105/jose.00075

This is how it will look in your documentation:

DOI

We need your help!

Journal of Open Source Education 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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted published Papers published in JOSE recommend-accept Papers recommended for acceptance in JOSE. review
Projects
None yet
Development

No branches or pull requests

7 participants