[REVIEW]: AliNe: A Flexible and Efficient Nextflow Pipeline for Read Alignmen

[editorialbot]

Submitting author: @Juke34 (Jacques Dainat)
Repository: https://github.com/Juke34/AliNe
Branch with paper.md (empty if default branch): main
Version: v1.0.0
Editor: @jromanowska
Reviewers: @rcannood, @gchure
Archive: Pending

Status

Status badge code:

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

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

@rcannood & @gchure, 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 @jromanowska 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 @gchure

📝 Checklist for @rcannood

[editorialbot]

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]

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

✅ OK DOIs

- 10.1093/BIOINFORMATICS/BTP324 is OK
- 10.1093/BIOINFORMATICS/BTP698 is OK
- 10.1038/NMETH.1923 is OK
- 10.1093/NAR/GKT214 is OK
- 10.1186/GB-2013-14-4-R36 is OK
- 10.1093/bioinformatics/bts635 is OK
- 10.1371/journal.pone.0163962 is OK
- 10.1093/bioinformatics/btw354 is OK
- 10.1038/nmeth.4197 is OK
- 10.1038/nbt.3820 is OK
- 10.1371/JOURNAL.PCBI.1005944 is OK
- 10.1038/s41592-018-0001-7 is OK
- 10.1101/720458 is OK
- 10.1038/s41587-019-0201-4 is OK
- 10.1093/BIOINFORMATICS/BTAB705 is OK
- 10.1093/gigascience/giab008 is OK
- 10.1002/imt2.107 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: novoAlign | Novocraft
- No DOI given, and none found for title: BBMap
- No DOI given, and none found for title: Aligning sequence reads, clone sequences and assem...
- No DOI given, and none found for title: FastQC

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.90  T=0.01 s (427.1 files/s, 70208.3 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Markdown                         3            117              0            342
TeX                              1              0              0            285
YAML                             1              2              1             75
-------------------------------------------------------------------------------
SUM:                             5            119              1            702
-------------------------------------------------------------------------------

Commit count by author:

    46	Jacques Dainat

[editorialbot]

Paper file info:

📄 Wordcount for paper.md is 714

✅ The paper includes a Statement of need section

[editorialbot]

License info:

✅ License found: MIT License (Valid open source OSI approved license)

[editorialbot]

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

[jromanowska]

👋🏼 @Juke34, @rcannood, @gchure, this is the review thread for the paper. All of our communications will happen here from now on.

As a reviewer, the first step is to create a checklist for your review by entering

@editorialbot generate my checklist

as the top of a new comment in this thread.

These checklists contain the JOSS requirements. As you go over the submission, please check any items that you feel have been satisfied. The first comment in this thread also contains links to the JOSS reviewer guidelines.

The JOSS review is different from most other journals. Our goal is to work with the authors to help them meet our criteria instead of merely passing judgment on the submission. As such, the reviewers are encouraged to submit issues and pull requests on the software repository. When doing so, please mention openjournals/joss-reviews#7545 so that a link is created to this thread (and I can keep an eye on what is happening). Please also feel free to comment and ask questions on this thread. In my experience, it is better to post comments/questions/suggestions as you come across them instead of waiting until you've reviewed the entire package.

We aim for reviews to be completed within about 2-4 weeks. Please let me know if any of you require some more time. We can also use EditorialBot (our bot) to set automatic reminders if you know you'll be away for a known period of time.

I encourage you to over-communicate and let everyone know that you're on the task every now and then, instead of waiting several weeks to collect all your comments, questions, or suggestions.

Please feel free to ping me (@jromanowska) if you have any questions/concerns.

[gchure]

Review checklist for @gchure

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

• I confirm that I read and will adhere to the JOSS code of conduct.

General checks

• Repository: Is the source code for this software available at the https://github.com/Juke34/AliNe?
• 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 (@Juke34) 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?

[jromanowska]

@Juke34, @rcannood, just a reminder that you need to generate your checklists

[Juke34]

Me too? Is it not only the reviewers?

[jromanowska]

Me too? Is it not only the reviewers?

You're correct! My mistake 🙈

[gchure]

@jromanowska Just an update -- holiday travel is coming up and I may be a week or two delayed in my review. I'll keep you updated as I go through my checklist!

[rcannood]

Review checklist for @rcannood

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

• I confirm that I read and will adhere to the JOSS code of conduct.

General checks

• Repository: Is the source code for this software available at the https://github.com/Juke34/AliNe?
• 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 (@Juke34) 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?

[jromanowska]

@jromanowska Just an update -- holiday travel is coming up and I may be a week or two delayed in my review. I'll keep you updated as I go through my checklist!

No problem - we all need a break at the end of this busy year 🙏

[jromanowska]

@rcannood , @gchure - I hope you had a great end-of-the-year break.
Just sending a kind reminder about this review. Please update us on your progress as soon as you start working on it.

[rcannood]

@rcannood , @gchure - I hope you had a great end-of-the-year break. Just sending a kind reminder about this review. Please update us on your progress as soon as you start working on it.

Thanks for the reminder! I started work on reviewing the functionality and software paper.

[gchure]

@rcannood , @gchure - I hope you had a great end-of-the-year break. Just sending a kind reminder about this review. Please update us on your progress as soon as you start working on it.

Thanks for the reminder as well! My plan is to resume working on it today.

Happy New Year to everyone!

[gchure]

Hi @jromanowska, hope you're doing well! I wanted to give a quick update that I've opened some issues with #5 being the most substantive to the work. I'm having some installation issues wrt Docker on my machine that are stopping me from running the tests, but will work on that over the next few days.

[Juke34]

@editorialbot generate pdf

[editorialbot]

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

[Juke34]

@editorialbot generate pdf
This version take in consideration reviews from @rcannood and @gchure

[editorialbot]

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

[jromanowska]

Great, keep up the good work! 💪

[gchure]

Hi @jromanowska and @Juke34, I've finished what I can of the review thus far. Issue #11 is the most pressing as it is precluding me from testing the functionality of the software. More specific information (container/init file) is needed to run the software as advertised. Issue #5 is a scientific blocker. From my perspective, this software should not enable the use of an outdated method (i.e. TopHat) which has numerous, well documented issues.

Once #11 is addressed, I'll continue with my review.

[jromanowska]

Thank you for the work and for the update, @gchure! Let's wait for the authors to work this out.

[Juke34]

@editorialbot generate pdf

This version responds to the latest concerns of the reviewiers.

[editorialbot]

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

[editorialbot]

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

[gchure]

Hi @jromanowska, all of my issues have been addressed and my checklist is complete. By my measure, the work is good to be published.

[jromanowska]

@rcannood - how is it going with your review?

[rcannood]

Thanks for the reminder -- it was quite busy the last week.

I'm currently reviewing the functionality claimed by authors and the documentation thereof, which are the last two items on my checklist.

[Juke34]

@editorialbot generate pdf

here are the last modifications. (Mainly end of the # Summary section to talk about available statistics provided by AliNe)

[editorialbot]

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

[Juke34]

@editorialbot generate pdf

[editorialbot]

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

[Juke34]

@editorialbot generate pdf

[editorialbot]

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

[jromanowska]

@Juke34, @rcannood - thank you for your work so far. Let me know if you are finished with the changes and review.

[Juke34]

Hi @jromanowska,
Yes I have finished with the changes, I'm waiting for @rcannood to review them