Skip to content

[REVIEW]: Adeft: Acromine-based Disambiguation of Entities from Text with applications to the biomedical literature #1708

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

Closed
38 tasks done
whedon opened this issue Sep 5, 2019 · 75 comments
Assignees
Labels
accepted published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. review

Comments

@whedon
Copy link

whedon commented Sep 5, 2019

Submitting author: @johnbachman (John Bachman)
Repository: https://github.com/indralab/adeft
Version: 0.5.3
Editor: @brainstorm
Reviewer: @GullyAPCBurns, @gbader
Archive: 10.5281/zenodo.3610528

Status

status

Status badge code:

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

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

@GullyAPCBurns & @gbader, 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 @brainstorm know.

Please try and complete your review in the next two weeks

Review checklist for @GullyAPCBurns

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?
  • Contribution and authorship: Has the submitting author (@johnbachman) made major 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?
  • 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: Do the authors clearly state 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?

Review checklist for @gbader

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?
  • Contribution and authorship: Has the submitting author (@johnbachman) made major 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?
  • 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: Do the authors clearly state 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 Sep 5, 2019

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @GullyAPCBurns, @gbader 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/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 Sep 5, 2019

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Sep 5, 2019

@brainstorm
Copy link
Member

@GullyAPCBurns @gbader, please go ahead and review away ;)

https://joss.readthedocs.io/en/latest/review_checklist.html

@brainstorm
Copy link
Member

@GullyAPCBurns @gbader, if you have doubts about how to proceed, please ask!

@gbader
Copy link

gbader commented Sep 26, 2019

Hello. I completed the review. The paper and software look good. My graduate student @JohnGiorgi helped review the software. We were able to get it to work and it successfully disambiguated “ER” (endoplasmic reticulum) in some test text.

@brainstorm
Copy link
Member

Great, thanks @gbader!

I've noticed that you left out "State of the field" in your review, @johnbachman, could you please address that in the manuscript?

@GullyAPCBurns, let us know if you have any difficulties with the review process, I'm here to assist!

@johnbachman
Copy link

@brainstorm Will do!

@johnbachman
Copy link

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Oct 11, 2019

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Oct 11, 2019

@johnbachman
Copy link

@brainstorm @gbader We added a new paragraph to the manuscript briefly describing where Adeft fits in the context of word sense disambiguation more generally.

@brainstorm
Copy link
Member

Thanks @johnbachman! @GullyAPCBurns, please let me know if you have any doubts about the review process?

@danielskatz
Copy link

👋 @GullyAPCBurns, @gbader - How are your reviews coming?

@gbader
Copy link

gbader commented Nov 2, 2019

The new paragraph looks great. In my view, this paper should be accepted.

Sorry for the delay. I like the idea of this journal, but one issue with running peer review on github is that the emails all come from github, which I happen to have filtered due to the large number of automated emails I get from github.

@brainstorm
Copy link
Member

Thanks @gbader for your input, we are still waiting for @GullyAPCBurns... shall we regard him as missing reviewer at this point as he's not replying?

@labarba
Copy link
Member

labarba commented Dec 21, 2019

@brainstorm — this submission has been silent for a while. It looks like you have an MIA reviewer. I suppose you did try to reach them by other means? (email, Twitter) It may be time to take some executive decision here on finding a replacement reviewer.

@johnbachman
Copy link

I contacted @GullyAPCBurns by email on Dec 13th, he said he would be able to review.

@GullyBurns
Copy link

Sincere apologies for having been unresponsive. I will recommit to completing this review as quickly as possible in the next two weeks.

@whedon
Copy link
Author

whedon commented Jan 8, 2020

Here are some things you can ask me to do:

# List Whedon's capabilities
@whedon commands

# List of editor GitHub usernames
@whedon list editors

# List of reviewers together with programming language preferences and domain expertise
@whedon list reviewers

EDITORIAL TASKS

# Compile the paper
@whedon generate pdf

# Compile the paper from alternative branch
@whedon generate pdf from branch custom-branch-name

# Ask Whedon to check the references for missing DOIs
@whedon check references

# Ask Whedon to check repository statistics for the submitted software
@whedon check repository

@GullyAPCBurns
Copy link

@danielskatz, I can't seem to check any of the boxes on the above form. Am I missing something very obvious?

@danielskatz
Copy link

Please see the first comment - did you accept the invite as mentioned in step 2 there?

@GullyAPCBurns
Copy link

Got it. Confirmed and yet more apologies for the delay.

@GullyAPCBurns
Copy link

I was able to review the paper and software. The code looks great and the documentation is exemplary. I ran the available Jupyter notebooks and was able to disambiguate 'Gut Cancer (GC)' effectively.

Again, I apologize for not having done this immediately. I'd recommend that you proceed with publication 'as is'.

@brainstorm
Copy link
Member

Great, thanks @GullyAPCBurns!

@kyleniemeyer
Copy link

@whedon check references

@whedon
Copy link
Author

whedon commented Jan 16, 2020

Reference check summary:

OK DOIs

- 10.1093/bioinformatics/btl534 is OK
- 10.1093/bioinformatics/btq129 is OK
- 10.15252/msb.20177651 is OK
- 10.1145/1459352.1459355 is OK
- 10.1089/cmb.2005.12.554 is OK
- 10.1016/j.jbi.2013.09.009 is OK
- 10.3115/1572364.1572374 is OK
- 10.1016/j.jbi.2010.08.009 is OK
- 10.18653/v1/p19-1569 is OK
- 10.1197/jamia.m1533 is OK

MISSING DOIs

- None

INVALID DOIs

- https://doi.org/10.18653/v1/p18-1230 is INVALID because of 'https://doi.org/' prefix

@kyleniemeyer
Copy link

@johnbachman your earlier requests to check the references didn't work because the PDF needed to be rebuilt first—thanks for adding those!

Can you remove https://doi.org/ from that one DOI causing an error? That should be the last edit needed.

@johnbachman
Copy link

Will do. After that's done, I will tag and release the latest version and update the Zenodo link.

@johnbachman
Copy link

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Jan 16, 2020

@johnbachman
Copy link

@whedon check references

@whedon
Copy link
Author

whedon commented Jan 16, 2020

Reference check summary:

OK DOIs

- 10.1093/bioinformatics/btl534 is OK
- 10.1093/bioinformatics/btq129 is OK
- 10.15252/msb.20177651 is OK
- 10.1145/1459352.1459355 is OK
- 10.1089/cmb.2005.12.554 is OK
- 10.1016/j.jbi.2013.09.009 is OK
- 10.3115/1572364.1572374 is OK
- 10.1016/j.jbi.2010.08.009 is OK
- 10.18653/v1/p19-1569 is OK
- 10.18653/v1/p18-1230 is OK
- 10.1197/jamia.m1533 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@johnbachman
Copy link

@whedon set 10.5281/zenodo.3610528 as archive

@whedon
Copy link
Author

whedon commented Jan 16, 2020

I'm sorry @johnbachman, I'm afraid I can't do that. That's something only editors are allowed to do.

@johnbachman
Copy link

johnbachman commented Jan 16, 2020

@brainstorm @kyleniemeyer The updated Zenodo archive (for Adeft version 0.5.5) is 10.5281/zenodo.3610528. Once that is updated we should be good to go.

@kyleniemeyer
Copy link

@whedon set 10.5281/zenodo.3610528 as archive

@whedon
Copy link
Author

whedon commented Jan 16, 2020

OK. 10.5281/zenodo.3610528 is the archive.

@kyleniemeyer
Copy link

@whedon accept

@whedon
Copy link
Author

whedon commented Jan 16, 2020

Attempting dry run of processing paper acceptance...

@whedon
Copy link
Author

whedon commented Jan 16, 2020

Reference check summary:

OK DOIs

- 10.1093/bioinformatics/btl534 is OK
- 10.1093/bioinformatics/btq129 is OK
- 10.15252/msb.20177651 is OK
- 10.1145/1459352.1459355 is OK
- 10.1089/cmb.2005.12.554 is OK
- 10.1016/j.jbi.2013.09.009 is OK
- 10.3115/1572364.1572374 is OK
- 10.1016/j.jbi.2010.08.009 is OK
- 10.18653/v1/p19-1569 is OK
- 10.18653/v1/p18-1230 is OK
- 10.1197/jamia.m1533 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Jan 16, 2020

Check final proof 👉 openjournals/joss-papers#1231

If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#1231, 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 Jan 16, 2020

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

@whedon
Copy link
Author

whedon commented Jan 16, 2020

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

@whedon
Copy link
Author

whedon commented Jan 16, 2020

🚨🚨🚨 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.01708 joss-papers#1232
  2. Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/joss.01708
  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

Congrats @johnbachman on your article's publication in JOSS!

Many thanks to @GullyAPCBurns and @gbader for reviewing, and @brainstorm for editing.

@whedon
Copy link
Author

whedon commented Jan 16, 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://joss.theoj.org/papers/10.21105/joss.01708/status.svg)](https://doi.org/10.21105/joss.01708)

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

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

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:

@johnbachman
Copy link

Thanks all!! @brainstorm @kyleniemeyer @gbader @GullyAPCBurns

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 recommend-accept Papers recommended for acceptance in JOSS. review
Projects
None yet
Development

No branches or pull requests

9 participants