Skip to content
Please note that GitHub no longer supports your web browser.

We recommend upgrading to the latest Google Chrome or Firefox.

Learn more
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]: Adeft: Acromine-based Disambiguation of Entities from Text with applications to the biomedical literature #1708

Open
whedon opened this issue Sep 5, 2019 · 42 comments
Assignees
Labels

Comments

@whedon
Copy link
Collaborator

@whedon 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.3608243

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

This comment has been minimized.

Copy link
Collaborator Author

@whedon 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

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Sep 5, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Sep 5, 2019

@brainstorm

This comment has been minimized.

Copy link
Member

@brainstorm brainstorm commented Sep 16, 2019

@brainstorm

This comment has been minimized.

Copy link
Member

@brainstorm brainstorm commented Sep 21, 2019

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

@gbader

This comment has been minimized.

Copy link
Collaborator

@gbader 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

This comment has been minimized.

Copy link
Member

@brainstorm brainstorm commented Sep 27, 2019

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

This comment has been minimized.

Copy link

@johnbachman johnbachman commented Sep 27, 2019

@brainstorm Will do!

@johnbachman

This comment has been minimized.

Copy link

@johnbachman johnbachman commented Oct 11, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Oct 11, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Oct 11, 2019

@johnbachman

This comment has been minimized.

Copy link

@johnbachman johnbachman commented Oct 11, 2019

@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

This comment has been minimized.

Copy link
Member

@brainstorm brainstorm commented Oct 20, 2019

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

@danielskatz

This comment has been minimized.

Copy link

@danielskatz danielskatz commented Nov 2, 2019

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

@gbader

This comment has been minimized.

Copy link
Collaborator

@gbader 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

This comment has been minimized.

Copy link
Member

@brainstorm brainstorm commented Nov 27, 2019

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

This comment has been minimized.

Copy link
Member

@labarba 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

This comment has been minimized.

Copy link

@johnbachman johnbachman commented Dec 24, 2019

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

@GullyBurns

This comment has been minimized.

Copy link

@GullyBurns GullyBurns commented Jan 8, 2020

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

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon 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

This comment has been minimized.

Copy link
Collaborator

@GullyAPCBurns GullyAPCBurns commented Jan 9, 2020

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

@danielskatz

This comment has been minimized.

Copy link

@danielskatz danielskatz commented Jan 9, 2020

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

@GullyAPCBurns

This comment has been minimized.

Copy link
Collaborator

@GullyAPCBurns GullyAPCBurns commented Jan 9, 2020

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

@GullyAPCBurns

This comment has been minimized.

Copy link
Collaborator

@GullyAPCBurns GullyAPCBurns commented Jan 10, 2020

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

This comment has been minimized.

Copy link
Member

@brainstorm brainstorm commented Jan 10, 2020

Great, thanks @GullyAPCBurns!

@brainstorm

This comment has been minimized.

Copy link
Member

@brainstorm brainstorm commented Jan 10, 2020

@whedon check references from branch joss-paper

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Jan 10, 2020

Attempting to check references... from custom branch joss-paper
@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Jan 10, 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

MISSING DOIs

- https://doi.org/10.1089/cmb.2005.12.554 may be missing for title: Word sense disambiguation in the biomedical domain: an overview
- https://doi.org/10.1016/j.jbi.2013.09.009 may be missing for title: Determining the difficulty of Word Sense Disambiguation
- https://doi.org/10.3115/1572364.1572374 may be missing for title: Disambiguation of Biomedical Abbreviations
- https://doi.org/10.1016/j.jbi.2010.08.009 may be missing for title: Disambiguation in the biomedical domain: the role of ambiguity type
- https://doi.org/10.18653/v1/p19-1569 may be missing for title: Language Modelling Makes Sense: Propagating Representations through WordNet for Full-Coverage Word Sense Disambiguation
- https://doi.org/10.18653/v1/p18-1230 may be missing for title: Incorporating Glosses into Neural Word Sense Disambiguation
- https://doi.org/10.1197/jamia.m1533 may be missing for title: A multi-aspect comparison study of supervised word sense disambiguation

INVALID DOIs

- None
@brainstorm

This comment has been minimized.

Copy link
Member

@brainstorm brainstorm commented Jan 10, 2020

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Jan 10, 2020

@brainstorm

This comment has been minimized.

Copy link
Member

@brainstorm brainstorm commented Jan 10, 2020

Looks good to my too, @johnbachman, next step is for you to deposit it on Zenodo and we'll archive it in JOSS, let me know if you run into any problems with that. Pretty close to publication now ;)

@johnbachman

This comment has been minimized.

Copy link

@johnbachman johnbachman commented Jan 13, 2020

Great, will do, thanks to all!

@johnbachman

This comment has been minimized.

Copy link

@johnbachman johnbachman commented Jan 14, 2020

(Edited with correct info)

Hi @brainstorm, the release for the paper is up at Zenodo here: https://zenodo.org/record/3608243

The version is 0.5.3, DOI is 10.5281/zenodo.3608243

Also, a question--should we add in DOIs for the 7 listed as "missing"?

@brainstorm

This comment has been minimized.

Copy link
Member

@brainstorm brainstorm commented Jan 14, 2020

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Jan 14, 2020

@johnbachman

This comment has been minimized.

Copy link

@johnbachman johnbachman commented Jan 14, 2020

@brainstorm Sorry, updated the comment above with correct DOI information

@brainstorm

This comment has been minimized.

Copy link
Member

@brainstorm brainstorm commented Jan 14, 2020

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Jan 14, 2020

https://zenodo.org/record/3608243 doesn't look like an archive DOI.

@brainstorm

This comment has been minimized.

Copy link
Member

@brainstorm brainstorm commented Jan 14, 2020

@whedon set 10.5281/zenodo.3608243 as archive

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Jan 14, 2020

OK. 10.5281/zenodo.3608243 is the archive.

@brainstorm

This comment has been minimized.

Copy link
Member

@brainstorm brainstorm commented Jan 14, 2020

No worries John, gotcha. @danielskatz LGTM, can you find any irregularity pre-publishing it for good?

@danielskatz

This comment has been minimized.

Copy link

@danielskatz danielskatz commented Jan 15, 2020

👋 @openjournals/joss-eics - I think this may be ready for you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
8 participants
You can’t perform that action at this time.