openjournals / joss-reviews

Reviews for the Journal of Open Source Software
Creative Commons Zero v1.0 Universal
714 stars 38 forks source link

[REVIEW]: Easy16S: a user-friendly Shiny web-service for exploration and visualization of microbiome data. #6704

Open editorialbot opened 5 months ago

editorialbot commented 5 months ago

Submitting author: !--author-handle-->@CedricMidoux<!--end-author-handle-- (Cédric Midoux) Repository: https://forgemia.inra.fr/migale/easy16s Branch with paper.md (empty if default branch): Version: v24.07 Editor: !--editor-->@fboehm<!--end-editor-- Reviewers: @adrientaudiere, @tmaklin Archive: 10.57745/ZN1HXQ

Status

status

Status badge code:

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

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

@adrientaudiere & @tmaklin, 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 @adrientaudiere

📝 Checklist for @tmaklin

editorialbot commented 5 months ago

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 commented 5 months ago

Software report:

github.com/AlDanial/cloc v 1.90  T=0.03 s (2046.4 files/s, 269308.5 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
R                               43            690           1342           3952
Markdown                         5            190              0            781
TeX                              1             17              0            193
YAML                             4             14              7            142
JSON                             1              0              0             19
Rmd                              2            104            152             12
Dockerfile                       1              0              1             10
CSS                              1              1              0              6
-------------------------------------------------------------------------------
SUM:                            58           1016           1502           5115
-------------------------------------------------------------------------------

Commit count by author:

   109  Cedric Midoux
    13  Mahendra Mariadassou
editorialbot commented 5 months ago
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1186/s40168-021-01013-0 is OK
- 10.1038/ismej.2014.202 is OK
- 10.1038/nmeth.3869 is OK
- 10.1186/s13059-014-0550-8 is OK
- 10.1093/bioinformatics/btx791 is OK
- 10.1111/1755-0998.13847 is OK
- 10.1111/geb.13118 is OK
- 10.1038/nature12506 is OK
- 10.1371/journal.pcbi.1005404 is OK
- 10.18129/b9.bioc.microbiome is OK
- 10.15454/1.5572390655343293E12 is OK
- 10.1371/journal.pone.0061217 is OK
- 10.1016/j.watres.2016.05.041 is OK
- 10.1038/nmeth.f.303 is OK
- 10.1186/s12859-020-03666-4 is OK
- 10.1093/bioinformatics/btu616 is OK

MISSING DOIs

- No DOI given, and none found for title: esquisse: Explore and Visualize Your Data Interact...
- No DOI given, and none found for title: shiny: Web Application Framework for R

INVALID DOIs

- None
editorialbot commented 5 months ago

Paper file info:

📄 Wordcount for paper.md is 849

✅ The paper includes a Statement of need section

editorialbot commented 5 months ago

License info:

🟡 License found: GNU Affero General Public License v3.0 (Check here for OSI approval)

editorialbot commented 5 months ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

adrientaudiere commented 5 months ago

Review checklist for @adrientaudiere

Conflict of interest

Code of Conduct

General checks

Functionality

Documentation

Software paper

adrientaudiere commented 5 months ago

Disclaimer: I am the developer of the MiscMetabar package, so I cite it a lot. My goal is to illustrate my review; I don't want to encourage authors to integrate MiscMetabar into their package.

Easy16S is a shiny-based application that facilitates simple analysis and visualization of metabarcoding data. I would first like to congratulate the authors for their effort to simplify the interface and to produce software that's pleasant to use. The paper is good and provides a good summary of the software's functions. I have two major suggestions to improve Easy16S and multiple little ones. My major suggestions are not true issues, so I wrote all my review in one text below. If you prefer, I can split the comments into separate gitlab issues.

Major comments/suggestions

Explain or at least alert about the complexity of interpreting results from very diverse metabarcoding studies

Focus on simplicity and rapidity is legitimate, but it may lead to biased figures or even false conclusions. As you notice in the text, if a biologist can emancipate from bioinformatician and biostatistician using your tool, the downside is the risk of misinterpretation of results. I think you should at least mention this risk in the main text. I think this can also be a force in your package. You, as bio-informatician/bio-statistician, choose default methods and parameters, and occasionally you even force some parameter values (e.g., the nb of permutation in permanova is not editable, and I think it’s a good decision). You may underline the fact that you put up guardrails in your software to decrease the risk of misusage of statistics.

Some parts are clearly lacking information

Minor comments

Specific comments for the case of the dataset data_fungi_mini available in the MiscMetabar package

CedricMidoux commented 5 months ago

Hello,

Thank you for your review and your suggestions. I'm going to correct the things you raised (particularly the documentation and user guidance). I'll get back to you when it's done.

fboehm commented 5 months ago

@tmaklin - do you have any questions about getting started with the review? Thanks again!

tmaklin commented 4 months ago

Review checklist for @tmaklin

Conflict of interest

Code of Conduct

General checks

Functionality

Documentation

Software paper

fboehm commented 4 months ago

@CedricMidoux - Do you have any questions about how to revise the submission materials?

CedricMidoux commented 4 months ago

I was waiting for the review from @tmaklin. I will start correcting the first feedback.

fboehm commented 4 months ago

That sounds good, @CedricMidoux ! please let me know if you have questions

fboehm commented 3 months ago

@tmaklin - how is the review going? Do you have questions on how to proceed?

fboehm commented 3 months ago

@CedricMidoux - have you had a chance to make changes per the suiggestions of @adrientaudiere ?

@tmaklin - do you have any questions about the review process?

Thanks again!

CedricMidoux commented 3 months ago

I was at the French R conference last week.
I will work on the first suggestions this week.

Thank you!

fboehm commented 3 months ago

@tmaklin - Just wanted to ask if you have any questions about the review process or how to get started.

Thanks again!

fboehm commented 3 months ago

@tmaklin - I hope that everything is ok. I just wanted to check to see how the review is going. Please feel free to update us. thank you again!

tmaklin commented 3 months ago

Hi @fboehm really sorry for the delay -- I've completed the review now. Like Adrien, I don't have anything major so I'll make my suggestions here, as this is already a complete and nice package.

Summary

The authors have created Easy16S, a browser-based tool for exploring microbiome data. Easy16S is implemented as an R package using Shiny to build the interactive parts. A goal of the tool is both to quickly perform standard microbiome analyses and to aid biologists without (R) programming skills.

The paper provides a clear and succint summary of the tool. The browser interface is clean and nice to use and accomplishes its goals. I have a few small suggestions/comments, in addition to supporting the observations made by Adrien, related to the statitical analyses but nothing major.

Minor suggestions

Alpha-ANOVA

Beta Multivariate ANOVA

PCA

Comments

Overall very nice work!

fboehm commented 3 months ago

THank you, @tmaklin ! @CedricMidoux - do you have any questions about how to proceed?

CedricMidoux commented 3 months ago

It's good for me. I'll get back to you as soon as possible. Thank you

fboehm commented 3 months ago

@CedricMidoux - just wanted to check in to see how the revisions are going. Do you have any questions on how to approach them?

CedricMidoux commented 2 months ago

@fboehm - I'm working on the revisions (review branch). I think I'll be able to deliver something by the middle/end of next week if that's good enough for you. Thank you

fboehm commented 2 months ago

@fboehm - I'm working on the revisions (review branch). I think I'll be able to deliver something by the middle/end of next week if that's good enough for you. Thank you

@CedricMidoux - that sounds great! thanks again! please let me know if you encounter any difficulties.

fboehm commented 2 months ago

@CedricMidoux - do you have any questions as you revise the software? Thanks again!

CedricMidoux commented 2 months ago

Hello @fboehm

I've tried to respond to as many of your comments as possible.
The current version is v24.07 (with review)

Here are a few more answers to the reviewers' feedback :

Generals comment

Rarefactions curves

Alpha-div

{phyloseq.extended}

Minors

I hope I've responded appropriately to all the remarks.

Thank you for your help and assistance

fboehm commented 2 months ago

@tmaklin @adrientaudiere - please review the latest updates from @CedricMidoux. would you leave a comment in this thread to indicate if further revisions are needed? Thank you again!

fboehm commented 1 month ago

@tmaklin @adrientaudiere - Thank you so much for the helpful reviews! I hope that we can work together on a future submission.

@CedricMidoux - the reviewers have approved your submission. I'll outline the next steps by issuing a command to the editorialbot

fboehm commented 1 month ago

@editorialbot list commands

editorialbot commented 1 month ago

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

@editorialbot commands

fboehm commented 1 month ago

@editorialbot commands

editorialbot commented 1 month ago

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 commented 1 month ago

Post-Review Checklist for Editor and Authors

Additional Author Tasks After Review is Complete

Editor Tasks Prior to Acceptance

fboehm commented 1 month ago

@CedricMidoux - a collection of "additional author tasks" is listed above. please feel free to enter the needed information in this thread. Thanks again!

CedricMidoux commented 1 month ago

@editorialbot generate pdf

editorialbot commented 1 month ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

CedricMidoux commented 1 month ago

@editorialbot set 10.57745/ZN1HXQ as archive

editorialbot commented 1 month ago

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

CedricMidoux commented 1 month ago

Thanks for your help for publishing in JOSS @fboehm ! Thanks again for your review @adrientaudiere and @tmaklin .

The release version is v24.07. The code is archived with Software Heritage (swh:1:rel:35d2caacc87474efa1f1e277f5eb13352962793d) and the release is posted on RechercheDataGouv (10.57745/ZN1HXQ)

The license is AGPL-3.0 on the website and in the repository, but in the draft paper, it is CC-BY-4.

Names, affiliations and ORCIDs of the author list have been checked.

fboehm commented 1 month ago

@editorialbot set v24.07 as version

editorialbot commented 1 month ago

Done! version is now v24.07

fboehm commented 1 month ago

@editorialbot set 10.57745/ZN1HXQ as archive

editorialbot commented 1 month ago

Done! archive is now 10.57745/ZN1HXQ

fboehm commented 1 month ago

Thank you, @CedricMidoux - I need to check on the license requirements for joss publications before I proceed further. I've sent a message to the other editors to ask about this. I'll update you when I hear from them.

fboehm commented 3 weeks ago

@CedricMidoux - thank you for your patience. I apologize for the delay. I believe that the license that you use adheres to joss policy, so there is no issue there. Sorry for the delay.

fboehm commented 3 weeks ago

@editorialbot generate pdf

editorialbot commented 3 weeks ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

CedricMidoux commented 3 weeks ago

@fboehm - Thank you. Should I do anything else? What is the next step in the process?

fboehm commented 1 week ago

Check that the archive title, author list, version tag, and the license are correct:

version tag in github repo: v24.07. version tag in archive: 24.07

author list in github repo (pdf linked above): Cédric Midoux 1,2,3 , Olivier Rué 2,3 , Olivier Chapleur 1 , Ariane Bize 1 , 4 Valentin Loux 2,3 , and Mahendra Mariadassou

author list in archive: MIDOUX, CEDRIC (INRAE) - idHAL: cedric-midoux

@CedricMidoux - can you fix the issue with different author lists? Maybe add the full list of authors (per your manuscript pdf here in github) to the metadata for the archive?