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]: PhyloX: A Python package for complete phylogenetic network workflows #6427

Open
editorialbot opened this issue Feb 28, 2024 · 46 comments
Assignees
Labels
Python review TeX Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented Feb 28, 2024

Submitting author: @RemieJanssen (Remie Janssen)
Repository: https://github.com/RemieJanssen/phylox
Branch with paper.md (empty if default branch):
Version: v1.0.3
Editor: @fboehm
Reviewers: @abhishektiwari, @bgyori
Archive: Pending

Status

status

Status badge code:

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

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

@abhishektiwari & @bgyori, 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:

@editorialbot generate my checklist

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @fboehm 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 @abhishektiwari

📝 Checklist for @bgyori

@editorialbot
Copy link
Collaborator Author

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:

@editorialbot commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

Software report:

github.com/AlDanial/cloc v 1.88  T=0.12 s (1707.9 files/s, 110963.9 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          68           1092           3159           6262
reStructuredText               128           1455            742            291
Markdown                         6             95              0            213
YAML                             4             17             27            104
TeX                              1              8              0             85
TOML                             1              4              0             35
DOS Batch                        1              8              1             26
make                             1              4              7              9
-------------------------------------------------------------------------------
SUM:                           210           2683           3936           7025
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

@editorialbot
Copy link
Collaborator Author

Wordcount for paper.md is 785

@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1093/bioinformatics/btp163 is OK

MISSING DOIs

- 10.1186/1471-2105-13-209 may be a valid DOI for title: Bio. Phylo: a unified toolkit for processing, analyzing and visualizing phylogenetic trees in Biopython
- 10.1093/bioinformatics/btq228 may be a valid DOI for title: DendroPy: a Python library for phylogenetic computing
- 10.1007/978-3-030-42266-0_8 may be a valid DOI for title: Linear time algorithm for tree-child network containment
- 10.1093/molbev/msx307 may be a valid DOI for title: Bayesian inference of species networks from multilocus sequence data
- 10.1007/978-3-030-42266-0_7 may be a valid DOI for title: Combining networks using cherry picking sequences

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@abhishektiwari
Copy link

abhishektiwari commented Mar 1, 2024

Review checklist for @abhishektiwari

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the https://github.com/RemieJanssen/phylox?
  • License: Does the repository contain a plain-text LICENSE or COPYING file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@RemieJanssen) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

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: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
  • 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?

@abhishektiwari
Copy link

@RemieJanssen Please see my initial comments.

Example code on documentation landing page did not run for me. Otherwise I was able run test scripts and create my own scripts without any issues.

A few minor typos in paper reported here. I also think first line of paper's Summary section as well other places describing PhyloX will read just fine without with tools, i.e. "PhyloX is a Python package for generating, manipulating, and analyzing phylogenetic networks."

@fboehm
Copy link

fboehm commented Mar 11, 2024

@bgyori - I hope that everything's ok. please feel free to create your review checklist. Please let me know if you have questions.

@fboehm
Copy link

fboehm commented Mar 11, 2024

@RemieJanssen - do you have any questions about the comments from & suggestions from @abhishektiwari ?

@bgyori
Copy link

bgyori commented Mar 18, 2024

Review checklist for @bgyori

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the https://github.com/RemieJanssen/phylox?
  • License: Does the repository contain a plain-text LICENSE or COPYING file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@RemieJanssen) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

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: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
  • 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?

@fboehm
Copy link

fboehm commented Mar 23, 2024

@bgyori - just wanted to check to see how the review is going; do you have any questions or need assistance as you look over things? Thank you!

@fboehm
Copy link

fboehm commented Mar 23, 2024

@RemieJanssen - did you have a chance to update the software in response to the comments from @abhishektiwari ? Please let us know if you need any clarifications. Thank you!

@bgyori
Copy link

bgyori commented Mar 23, 2024

I have now completed my initial review, see checklist above. Below, I provide further context for checkboxes that I didn't check.

General checks

  • Substantial scholarly effort: following the review guidelines at https://joss.readthedocs.io/en/latest/submitting.html#substantial-scholarly-effort, here are my observations on this: the code was written by a single author over a limited period of time. There are no external stars/watchers/forks/issue submitters for the project so usage has not yet been demonstrated. Despite this, the quantitative metrics over the code (i.e., number of lines) and my own review of the code show that the work put into the implementation is not trivial. If these characteristics are consistent with a JOSS publication, I can check this box - guidance from @fboehm would be helpful.

  • Reproducibility: across the entire repository, documentation and paper, there
    is a single piece of example code demonstrating the software, however, this
    does not work as expected. One or more demonstration notebooks of the utility of the
    software on some example use cases would improve the package and the paper.

Functionality

  • Functionality: The functionality of the software is not clearly described.
    Across the repository's README, the documentation, and the paper there isn't a
    single place where a clear and well structured summary exists of the software's
    functionalities. This should be improved for clarity and usability.

Documentation

Software paper

  • Summary: the current description is not clear, especially for a non-specialist audience. It could be improved by a clearer description of the basic concepts the package uses (e.g., phylogenetic network vs tree, what is "cherry-picking", etc.). Obviously one can't expect to go into details so this would have to be succinct and to the point. Perhaps approaching this by more clearly stating the kinds of analysis the package enables could also help.

  • Quality of writing: Currently more than half of the paper is discussing other related tools. This should be rebalanced by focusing on PhyloX and giving a proper description of it. I also found some typos and language issues that I submitted a PR to improve.

@RemieJanssen
Copy link

**fboehm ** commented Mar 23, 2024

@fboehm I have updated the software to fix the main example in the documentation. It's still only in the main branch, so it's not released yet. I'll do that once I have updated the paper, and possibly the documentation, if that is required as well.

@bgyori Thank you for the explanation of the non-checked items. I will go through those and respond and fix what I can.

@fboehm What is generally the way forward in this phase? I'm quite used to the clearly delineated phases of a more conventional review process, this seems somewhat more fluid.

I'm sorry I'm taking so long, I unfortunately do not have as much time to work on this as I would want to.

@abhishektiwari
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@abhishektiwari
Copy link

@RemieJanssen

Please see more feedback

Quality of writing

Some parts need rewriting like related packages (State of the field). It can be more crisp, bit shorter (as suggested by other reviewer), and objective. I will avoid using weasel phrases like fit that bill to a certain extent, and be more specific. I felt comparison on the documentation page did a better job by calling out the specific differences between PhyloX and alternatives.

Unlike other packages like Biopython and DendroPy, PhyloX is designed to work with phylogenetic networks, rather than phylogenetic trees.

I also suggest highlighting some of the key features/functionalities of the PhyloX software in paper. Again, I think documentation page does a better job describing key features of PhyloX.

Example usage

Thanks for fixing the example. I would love to see one or two Jupyter notebook based example use cases. But this is not a blocker from my side.

API documentation

Module functions for the health generator are missing please fix RST tree.

@fboehm
Copy link

fboehm commented Apr 15, 2024

@RemieJanssen - do you have questions about next steps? Thanks again!

@fboehm
Copy link

fboehm commented Apr 15, 2024

@RemieJanssen - do you have questions about next steps? Thanks again!

Sorry that I missed your earlier messsge. Yes, compared to some review processes, that of Joss may feel different. It is essentially an iterative process between you and the reviewers. Once they are able to check all boxes, their roles are complete. As author, you just need to respond to their suggestions. If you disagree with a suggestion, please discuss it in this thread.

@bgyori
Copy link

bgyori commented Apr 20, 2024

I'm just checking back again, @RemieJanssen have you had a chance to look into the paper improvements / documentation improvements that @abhishektiwari and I suggested? I don't see any recent changes since my PR was merged with some typo fixes, though I might have missed something.

@RemieJanssen
Copy link

@RemieJanssen - do you have questions about next steps? Thanks again!

Sorry that I missed your earlier messsge. Yes, compared to some review processes, that of Joss may feel different. It is essentially an iterative process between you and the reviewers. Once they are able to check all boxes, their roles are complete. As author, you just need to respond to their suggestions. If you disagree with a suggestion, please discuss it in this thread.

Ah! That does answer my question, thank you :) I finally have some time again, so I'll try to get as far as possible responding to all the comments this week.

@RemieJanssen
Copy link

I have now completed my initial review, see checklist above. Below, I provide further context for checkboxes that I didn't check.

General checks

* **Substantial scholarly effort**: following the review guidelines at https://joss.readthedocs.io/en/latest/submitting.html#substantial-scholarly-effort, here are my observations on this: the code was written by a single author over a limited period of time. There are no external stars/watchers/forks/issue submitters for the project so usage has not yet been demonstrated. Despite this, the quantitative metrics over the code (i.e., number of lines) and my own review of the code show that the work put into the implementation is not trivial. If these characteristics are consistent with a JOSS publication, I can check this box - guidance from @fboehm would be helpful.

I don't think I can really argue with you here, most of the package was written by me, and compiled over a short period of time. However, it's not really true that it was written over a limited period. The package is a compilation of most code was written during the 4 years of my PhD and the few years after (and not even all by me, but also by co-authors). This package is an attempt to not let all that effort go to waste because of our unFAIR code practices.

@fboehm
Copy link

fboehm commented Apr 22, 2024

I have now completed my initial review, see checklist above. Below, I provide further context for checkboxes that I didn't check.
General checks

* **Substantial scholarly effort**: following the review guidelines at https://joss.readthedocs.io/en/latest/submitting.html#substantial-scholarly-effort, here are my observations on this: the code was written by a single author over a limited period of time. There are no external stars/watchers/forks/issue submitters for the project so usage has not yet been demonstrated. Despite this, the quantitative metrics over the code (i.e., number of lines) and my own review of the code show that the work put into the implementation is not trivial. If these characteristics are consistent with a JOSS publication, I can check this box - guidance from @fboehm would be helpful.

I don't think I can really argue with you here, most of the package was written by me, and compiled over a short period of time. However, it's not really true that it was written over a limited period. The package is a compilation of most code was written during the 4 years of my PhD and the few years after (and not even all by me, but also by co-authors). This package is an attempt to not let all that effort go to waste because of our unFAIR code practices.

@RemieJanssen @bgyori - can you elaborate on this point? Why does it appear to @bgyori that things were written over a short period while @RemieJanssen says otherwise? Is @bgyori relying on git commit times, while @RemieJanssen and co-workers perhaps didn't use git while writing?

@bgyori
Copy link

bgyori commented Apr 22, 2024

I have now completed my initial review, see checklist above. Below, I provide further context for checkboxes that I didn't check.
General checks

* **Substantial scholarly effort**: following the review guidelines at https://joss.readthedocs.io/en/latest/submitting.html#substantial-scholarly-effort, here are my observations on this: the code was written by a single author over a limited period of time. There are no external stars/watchers/forks/issue submitters for the project so usage has not yet been demonstrated. Despite this, the quantitative metrics over the code (i.e., number of lines) and my own review of the code show that the work put into the implementation is not trivial. If these characteristics are consistent with a JOSS publication, I can check this box - guidance from @fboehm would be helpful.

I don't think I can really argue with you here, most of the package was written by me, and compiled over a short period of time. However, it's not really true that it was written over a limited period. The package is a compilation of most code was written during the 4 years of my PhD and the few years after (and not even all by me, but also by co-authors). This package is an attempt to not let all that effort go to waste because of our unFAIR code practices.

@RemieJanssen @bgyori - can you elaborate on this point? Why does it appear to @bgyori that things were written over a short period while @RemieJanssen says otherwise? Is @bgyori relying on git commit times, while @RemieJanssen and co-workers perhaps didn't use git while writing?

Based on @RemieJanssen's comments, I understand that the code was written over a several years but was consolidated into this integrated repository later, over a shorter period of time. This makes sense to me, and I definitely see the value in turning fragmented code into an integrated and reusable package.

@RemieJanssen
Copy link

I have now completed my initial review, see checklist above. Below, I provide further context for checkboxes that I didn't check.
General checks

* **Substantial scholarly effort**: following the review guidelines at https://joss.readthedocs.io/en/latest/submitting.html#substantial-scholarly-effort, here are my observations on this: the code was written by a single author over a limited period of time. There are no external stars/watchers/forks/issue submitters for the project so usage has not yet been demonstrated. Despite this, the quantitative metrics over the code (i.e., number of lines) and my own review of the code show that the work put into the implementation is not trivial. If these characteristics are consistent with a JOSS publication, I can check this box - guidance from @fboehm would be helpful.

I don't think I can really argue with you here, most of the package was written by me, and compiled over a short period of time. However, it's not really true that it was written over a limited period. The package is a compilation of most code was written during the 4 years of my PhD and the few years after (and not even all by me, but also by co-authors). This package is an attempt to not let all that effort go to waste because of our unFAIR code practices.

@RemieJanssen @bgyori - can you elaborate on this point? Why does it appear to @bgyori that things were written over a short period while @RemieJanssen says otherwise? Is @bgyori relying on git commit times, while @RemieJanssen and co-workers perhaps didn't use git while writing?

Based on @RemieJanssen's comments, I understand that the code was written over a several years but was consolidated into this integrated repository later, over a shorter period of time. This makes sense to me, and I definitely see the value in turning fragmented code into an integrated and reusable package.

That is correct. If you want to see proof of this, take a look at the second commit: RemieJanssen/PhyloX@2b412c8
This is where I started PhyloX by simply dumping all scripts I could find in one git repo.

@RemieJanssen
Copy link

RemieJanssen commented Apr 25, 2024

I tried to re-balance the paper as @bgyori suggested, in this PR: RemieJanssen/PhyloX#52
Please let me know if this is the direction you were thinking of. If it is, I will go through the paper again to clean up the text (language and structure), but I'd first like to know if these additions are wanted/necessary/appreciated.

@RemieJanssen
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@RemieJanssen
Copy link

@bgyori
Your comment on the Community guidelines is handled in RemieJanssen/PhyloX#50

About the Functionality documentation. Did you have any problems navigating the docs besides the issue of missing docstrings?
The missing docstrings will be fixed in

I think that is all of them (except some helper functions for API methods), please let me know if you find any more

@fboehm
Copy link

fboehm commented Apr 30, 2024

@bgyori - do you have any feedback for @RemieJanssen in response to the latest changes?

@bgyori
Copy link

bgyori commented Apr 30, 2024

As far as I understand, @RemieJanssen is working on some documentation updates still (is that right?), I will reassess everything once that is wrapped up.

@RemieJanssen
Copy link

@bgyori I have filled in the missing docstrings wherever I could find them, and I have improved (hopefully) the navigability of the docs: https://phylox.readthedocs.io/en/latest/

If you find anything else, please let me know :)

@fboehm
Copy link

fboehm commented May 21, 2024

@abhishektiwari @bgyori @RemieJanssen - how are the reviews going? Has @RemieJanssen addressed your concerns? Or is there more revision needed?

@abhishektiwari
Copy link

abhishektiwari commented May 21, 2024

@fboehm I have marked my review completed. Thanks authors for updating documentation and paper.

@fboehm
Copy link

fboehm commented May 23, 2024

Thank you for the helpful review, @abhishektiwari !

@fboehm
Copy link

fboehm commented May 23, 2024

@bgyori - have you had a chance to review the latest revisions from @RemieJanssen ?

@fboehm
Copy link

fboehm commented May 28, 2024

@bgyori - I hope that things are going ok. Have you had a chance to review changes from @RemieJanssen ? DO you have any questions on how to proceed?

@bgyori
Copy link

bgyori commented May 29, 2024

I will aim to finish my review before the end of this week.

@bgyori
Copy link

bgyori commented May 30, 2024

Thanks @RemieJanssen, I think all aspects of the software and paper have been improved substantially and I checked all the review boxes. I submitted a PR with a couple of small typo fixes to the paper.

@fboehm
Copy link

fboehm commented Jun 1, 2024

Thanks, @bgyori ! @RemieJanssen - please let me know when you've addressed the PR from @bgyori . Thanks again!

@RemieJanssen
Copy link

Thanks @bgyori and @abhishektiwari for the helpful reviews, and @fboehm for the smooth process!
I have addressed the last PR from bgyori and fixed a few typos myself as well.
This must mean that we can finish up this phase, is that correct?

The last thing I'd like to fix is some metadata.
I see the version is still 1.0.3 at the top of this thread.
The version the paper corresponds to should be updated I think, is that still possible, and how do I do that?

@fboehm
Copy link

fboehm commented Jun 8, 2024

@editorialbot list commands

@editorialbot
Copy link
Collaborator Author

I'm sorry human, I don't understand that. You can see what commands I support by typing:

@editorialbot commands

@fboehm
Copy link

fboehm commented Jun 9, 2024

@editorialbot commands

@editorialbot
Copy link
Collaborator Author

Hello @fboehm, here are the things you can ask me to do:


# List all available commands
@editorialbot commands

# Add to this issue's reviewers list
@editorialbot add @username as reviewer

# Remove from this issue's reviewers list
@editorialbot remove @username from reviewers

# Get a list of all editors's GitHub handles
@editorialbot list editors

# Assign a user as the editor of this submission
@editorialbot assign @username as editor

# Remove the editor assigned to this submission
@editorialbot remove editor

# Remind an author, a reviewer or the editor to return to a review after a 
# certain period of time (supported units days and weeks)
@editorialbot remind @reviewer in 2 weeks

# Adds a checklist for the reviewer using this command
@editorialbot generate my checklist

# Set a value for version
@editorialbot set v1.0.0 as version

# Set a value for branch
@editorialbot set joss-paper as branch

# Set a value for repository
@editorialbot set https://github.com/organization/repo as repository

# Set a value for the archive DOI
@editorialbot set 10.5281/zenodo.6861996 as archive

# Mention the EiCs for the correct track
@editorialbot ping track-eic

# Run checks and provide information on the repository and the paper file
@editorialbot check repository

# Check the references of the paper for missing DOIs
@editorialbot check references

# Generates the pdf paper
@editorialbot generate pdf

# Recommends the submission for acceptance
@editorialbot recommend-accept

# Generates a LaTeX preprint file
@editorialbot generate preprint

# Flag submission with questionable scope
@editorialbot query scope

# Get a link to the complete list of reviewers
@editorialbot list reviewers

# Creates a post-review checklist with editor and authors tasks
@editorialbot create post-review checklist

# Open the review issue
@editorialbot start review

@fboehm
Copy link

fboehm commented Jun 9, 2024

Post-Review Checklist for Editor and Authors

Additional Author Tasks After Review is Complete

  • Double check authors and affiliations (including ORCIDs)
  • Make a release of the software with the latest changes from the review and post the version number here. This is the version that will be used in the JOSS paper.
  • Archive the release on Zenodo/figshare/etc and post the DOI here.
  • Make sure that the title and author list (including ORCIDs) in the archive match those in the JOSS paper.
  • Make sure that the license listed for the archive is the same as the software license.

Editor Tasks Prior to Acceptance

  • Read the text of the paper and offer comments/corrections (as either a list or a pull request)
  • Check that the archive title, author list, version tag, and the license are correct
  • Set archive DOI with @editorialbot set <DOI here> as archive
  • Set version with @editorialbot set <version here> as version
  • Double check rendering of paper with @editorialbot generate pdf
  • Specifically check the references with @editorialbot check references and ask author(s) to update as needed
  • Recommend acceptance with @editorialbot recommend-accept

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Python review TeX Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials
Projects
None yet
Development

No branches or pull requests

5 participants