-
-
Notifications
You must be signed in to change notification settings - Fork 38
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]: MousebreedeR: A novel software to assist in the design of breeding schema for complex genotypes of experimental organisms #6474
Comments
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:
For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:
|
|
Software report:
Commit count by author:
|
Paper file info: 📄 Wordcount for ✅ The paper includes a |
License info: ✅ License found: |
👋🏼 @sportiellomike, @yjunechoe, @jsun - this is the review thread for the submission. 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
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 directly in the software repository. If you do so, please mention this thread so that a link is created (and I can keep an eye on what is happening). Please also feel free to comment and ask questions in this thread. It is often easier 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. Please feel free to ping me (@csoneson) if you have any questions or concerns. Thanks! |
Review checklist for @yjunechoeConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
👋🏻 Just wanted to check in to see that things were going well here and that there are no questions about the process (@jsun - I see that you haven't yet created your checklist, let me know if you have any questions!) |
Hi @csoneson - I'm returning to this review after my first pass at the checklist (I have been awaiting a response from the author about automated tests before I proceed further) I took some time to read the contents of this package more closely, and I have some serious concerns about the Substantial scholarly effort criterion. Inside the package I count 12 functions - a combined LOC of 273 lines and an average of 23 lines for each function (LOC range: 4-45). Looking at internal function calls as a proxy for complexity, each function in the package is composed of an average 13 calls to other functions, mostly I'm afraid there's not much for me to work with here to evaluate the package. As per the review guidelines, I would like to flag the submission as questionable scope before proceeding further. Analysis of substantial scholarly effort## Setup
functions <- c(
"addmouseID",
"addpoints",
"canwegetalltheallelesfromonecross",
"compilegametes",
"engageinmeiosis",
"fertilize",
"pointsperpup",
"possiblepointsfromdesiredoutcome",
"spermandeggs",
"summarizefertilization",
"summarizepotentialpups",
"whichpairsshouldibreed"
)
length(functions)
#> [1] 12
endpoint <- "https://raw.githubusercontent.com/sportiellomike/mousebreedeR/main/R/"
files <- file.path(endpoint, paste0(functions, ".R"))
lines <- lapply(files, readLines)
## Code lines
count_code_lines <- function(x) {
code <- grep("^(#|\\s*$)", x, invert = TRUE, value = TRUE)
length(code)
}
all_code_lines <- sapply(lines, count_code_lines)
sum(all_code_lines)
#> [1] 273
mean(all_code_lines)
#> [1] 22.75
range(all_code_lines)
#> [1] 4 45
## Function complexity
parsed <- lapply(lines, \(x) parse(text = paste(x, collapse = "\n")))
parse_data <- do.call(rbind, lapply(parsed, getParseData))
function_calls <- parse_data |>
subset(token == "SYMBOL_FUNCTION_CALL" & !text %in% functions) |>
el("text") |>
table()
head(sort(function_calls, decreasing = TRUE))
#>
#> which c return print subset length
#> 18 13 12 9 8 7
sum(function_calls)
#> [1] 152
sum(function_calls)/length(functions)
#> [1] 12.66667 |
|
Hi @sportiellomike - thanks for the quick response, and I apologize for not being clear on the issue I opened on automated tests To your points - I understand your perspective on the usefulness of the tool (albeit I've not fully evaluated this formally). I only mean to comment on the structure and contents of the package as an open source software developed for general consumption, according to the scope and standards of JOSS specifically. To clarify, I'm following the practice of previous reviewers who have raised issues of LOC and complexity as part of evaluating the substantial scholarly effort criterion (see similar issues). I'm happy to complete the review and help with the review process up to a successful publication, but substantial scholarly effort is a rather tricky matter to resolve, especially if the package is already considered to be at a feature-complete state that addresses its goals. I only seek clarification from the editorial team - I apologize again for the interruption. |
@yjunechoe Thanks for voicing your concern. Let me bring this up with the broader editor team and get back to you. |
@editorialbot query scope |
Submission flagged for editorial review. |
Sorry for the delay. Ill finish my review for next week. |
Review checklist for @jsunConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
@csoneson: the reviewer @yjunechoe encouraged me to comment here regarding the "substantial scholarly effort" guideline in the other thread. While I understand it to be the case JOSS wants longer submissions, I wanted to be clear that this project was created for the purpose of solving specific problems: the unnecessary death of experimental animals by requiring fewer crosses and therefore animals used, as well as increasing the speed of which experimentalists can obtain their desired animal of correct genotype. As a result, i believe this submission to be a substantial contribution as it has achieved those goals. It is true it is a smaller package, but it still is a large contribution to the field of experimental animal morbidity/mortality reduction, of which there is minimal resources, and no software resources that are free and open source to my knowledge. I am glad I was able to achieve these goals in a moderate number of lines of code instead of a large number as it is more efficient, though I freely admit this package is smaller than most published in JOSS. I hope you agree. |
This package contains simple but important features to assist wet researchers. Therefore, I think, the main target users of this package would be wet researchers who are unfamiliar with coding programmes. Therefore, I recommend the author to create easy-to-use functions and clear documentation (vignette). The following comments are based on a check of this contribution.
|
Thanks @sportiellomike - the editorial team is discussing the submission and we should have an answer for you soon! Thanks for your patience. |
Thank you for your patience, and thanks again @yjunechoe for raising the point about the scope. The editorial team has carefully reviewed the submission and the discussion, and we felt that although it is close to borderline, we would consider it in scope, and it seems to provide useful functionality for the target audience. Thus, I would encourage the reviewers to continue their evaluation of the submission. Thanks! |
@csoneson Thanks for the clarification! @sportiellomike Apologies again for the interruption. I'll complete the rest of my review swiftly. |
Great, thanks - I'll make a new post below describing the next steps. |
Post-Review Checklist for Editor and AuthorsAdditional Author Tasks After Review is Complete
Editor Tasks Prior to Acceptance
|
|
@csoneson I think we're all set here on my end! See above comment for doi etc. |
Thanks. Could you please edit the metadata of the Zenodo archive so that the title agrees with that of the paper? Also the format of the last author's name is slightly different (with/without the middle 'J'). Also one thing that I noticed only now - the GitHub repo and the LICENSE.md file gives the license as MIT; however, the License field in the DESCRIPTION file says 'CC BY 4.0'. Could you please change the latter to also be MIT? |
Sorry i missed those things @csoneson. |
@editorialbot set 10.5281/zenodo.11405147 as archive |
Done! archive is now 10.5281/zenodo.11405147 |
@editorialbot set v1.0.0 as version |
Done! version is now v1.0.0 |
Thanks - this looks good to me, I will hand off to the topic AEiC for the last steps. Thanks for submitting to JOSS! |
@editorialbot recommend-accept |
|
|
👋 @openjournals/bcm-eics, this paper is ready to be accepted and published. Check final proof 👉📄 Download article If the paper PDF and the deposit XML files look good in openjournals/joss-papers#5435, then you can now move forward with accepting the submission by compiling again with the command |
@sportiellomike as AEiC for JOSS I will now help to process this submission for acceptance in JOSS. I have checked this review, your repository, the archive link, and the paper. Everything appears in order so I will now continue to accept this work in JOSS. |
@editorialbot accept |
|
Ensure proper citation by uploading a plain text CITATION.cff file to the default branch of your repository. If using GitHub, a Cite this repository menu will appear in the About section, containing both APA and BibTeX formats. When exported to Zotero using a browser plugin, Zotero will automatically create an entry using the information contained in the .cff file. You can copy the contents for your CITATION.cff file here: CITATION.cff
If the repository is not hosted on GitHub, a .cff file can still be uploaded to set your preferred citation. Users will be able to manually copy and paste the citation. |
🐘🐘🐘 👉 Toot for this paper 👈 🐘🐘🐘 |
🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨 Here's what you must now do:
Any issues? Notify your editorial technical team... |
@sportiellomike congratulations on this JOSS publication! 🎉 At this point I would like to thank @csoneson for editing this submission! And a special thank you also to the reviewers: @yjunechoe, @jsun !!!! |
🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉 If you would like to include a link to your paper from your README use the following code snippets:
This is how it will look in your documentation: We need your help! The 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:
|
Submitting author: @sportiellomike (Mike Sportiello)
Repository: https://github.com/sportiellomike/mousebreedeR
Branch with paper.md (empty if default branch):
Version: v1.0.0
Editor: @csoneson
Reviewers: @yjunechoe, @jsun
Archive: 10.5281/zenodo.11405147
Status
Status badge code:
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
@yjunechoe & @jsun, 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:
The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @csoneson 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 @yjunechoe
📝 Checklist for @jsun
The text was updated successfully, but these errors were encountered: