-
-
Notifications
You must be signed in to change notification settings - Fork 104
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
Submission tidyqpcr - Quantitative PCR analysis in the tidyverse #470
Comments
Thanks for submitting to rOpenSci, our editors and @ropensci-review-bot will reply soon. Type |
🚀 Editor check started 👋 |
Checks for tidyqpcr (v0.3)git hash: 4bce0332
Important: All failing checks above must be addressed prior to proceeding Package License: Apache License 2.0 + file LICENSE 1. Statistical PropertiesThis package features some noteworthy statistical properties which may need to be clarified by a handling editor prior to progressing. Details of statistical properties (click to open)
The package has:
Statistical properties of package structure as distributional percentiles in relation to all current CRAN packages
The final measure (
1a. Network visualisationInteractive network visualisation of calls between objects in package can be viewed by clicking here 2.
|
message | number of times |
---|---|
Lines should not be more than 80 characters. | 85 |
Package Versions
package | version |
---|---|
pkgstats | 0.0.2.3 |
pkgcheck | 0.0.2.53 |
Editor-in-Chief Instructions:
Processing may not proceed until the items marked with ✖️ have been resolved.
@ropensci-review-bot assign @jooolia as editor |
Assigned! @jooolia is now the editor |
@ropensci-review-bot help |
Hello @DimmestP, here are the things you can ask me to do:
|
Helpful! Hello!! Thank you for spending your time helping us improve tidyqpcr. I have added a few commits to the main tidyqpcr repo that I think solve the remaining issues. How can I get the review bot to check again? What is the process that it uses to check for function examples? I ran |
@ropensci-review-bot check package |
Thanks, about to send the query. |
🚀 Editor check started 👋 |
Checks for tidyqpcr (v0.3)git hash: 737cca43
Package License: Apache License 2.0 + file LICENSE 1. Statistical PropertiesThis package features some noteworthy statistical properties which may need to be clarified by a handling editor prior to progressing. Details of statistical properties (click to open)
The package has:
Statistical properties of package structure as distributional percentiles in relation to all current CRAN packages
The final measure (
1a. Network visualisationInteractive network visualisation of calls between objects in package can be viewed by clicking here 2.
|
name | conclusion | sha | date |
---|---|---|---|
.github/workflows/draft-pdf.yml | success | 737cca | 2021-10-13 |
fair-software | success | 737cca | 2021-10-13 |
R-CMD-check | success | 737cca | 2021-10-13 |
3b. goodpractice
results
R CMD check
with rcmdcheck
R CMD check generated the following notes:
- checking installed package size ... NOTE
installed size is 12.7Mb
sub-directories of 1Mb or more:
doc 2.8Mb
extdata 9.7Mb - checking DESCRIPTION meta-information ... NOTE
License components with restrictions not permitted:
Apache License 2.0 + file LICENSE - checking package subdirectories ... NOTE
Found the following CITATION file in a non-standard place:
CITATION.cff
Most likely ‘inst/CITATION’ should be used instead.
R CMD check generated the following check_fails:
- no_description_depends
- rcmdcheck_not_permitted_license_restrictions
- rcmdcheck_citation_file_at_standard_place
- rcmdcheck_reasonable_installed_size
Test coverage with covr
Package coverage: 79.72
Cyclocomplexity with cyclocomp
No functions have cyclocomplexity >= 15
Static code analyses with lintr
lintr found the following 94 potential issues:
message | number of times |
---|---|
Lines should not be more than 80 characters. | 94 |
Package Versions
package | version |
---|---|
pkgstats | 0.0.2.16 |
pkgcheck | 0.0.2.86 |
Editor-in-Chief Instructions:
This package is in top shape and may be passed on to a handling editor
Hi @DimmestP, Regarding the examples, there is no pre-set % that we require (as far as I know and from re-reading the packaging guide), right now it is stated as "Include extensive examples in the documentation", so I will let the reviewers comment on whether they think some functions are missing examples or not. Thanks! Julia |
@jooolia The above check is all ✔️, including
|
ha you are right @mpadge! thanks for pointing that out. |
@ropensci-review-bot add @kelshmo to reviewers |
@kelshmo added to the reviewers list. Review due date is 2021-11-19. Thanks @kelshmo for accepting to review! Please refer to our reviewer guide. |
@ropensci-review-bot add @wolski to reviewers |
@wolski added to the reviewers list. Review due date is 2021-12-10. Thanks @wolski for accepting to review! Please refer to our reviewer guide. |
Hi @jooolia, Thank you for this thorough check, it has helped a lot and given us more opportunity for improvements. @DimmestP and I have addressed these:
We hope that's everything for the review process? Let us know. Also we are open to suggestions as to whether it is better to share via CRAN or via Bioconductor. I really don't know. |
@ropensci-review-bot submit review #470 (comment) time 12 |
Dear @ewallace and @DimmestP, Regarding CRAN vs. Bioconductor, my personal opinion is that it depends on your targeted users, dependencies and perhaps future plans for the package. Many rOpenSci packages are on CRAN. Right now I am aware (thanks to @maelle 's help) of two rOpenSci pacakges that are on Bioconductor: https://docs.ropensci.org/genbankr/ and https://github.com/YuLab-SMU/treeio . Both CRAN and Bioconductor have their own "gotchas" as detailed in dev guide sections 1.16 and 1.17 https://devguide.ropensci.org/building.html?q=bioconductor#bioconductor-gotchas |
@ropensci-review-bot approve tidyqpcr |
Approved! Thanks @ewallace for submitting and @kelshmo for your reviews! 😁 To-dos:
Should you want to acknowledge your reviewers in your package DESCRIPTION, you can do so by making them Welcome aboard! We'd love to host a post about your package - either a short introduction to it with an example for a technical audience or a longer post with some narrative about its development or something you learned, and an example of its use for a broader readership. If you are interested, consult the blog guide, and tag @ropensci/blog-editors in your reply. She will get in touch about timing and can answer any questions. We maintain an online book with our best practice and tips, this chapter starts the 3d section that's about guidance for after onboarding (with advice on releases, package marketing, GitHub grooming); the guide also feature CRAN gotchas. Please tell us what could be improved. Last but not least, you can volunteer as a reviewer via filling a short form. |
@ropensci-review-bot finalize transfer of tidyqpcr |
Transfer completed. |
Thank you @jooolia.
These are all addressed in a branch pending review... |
@ropensci-review-bot give codecov access to ropensci/tidy |
I'm sorry human, I don't understand that. You can see what commands I support by typing:
|
@ewallace We're just tring to find out why |
Thank you @mpadge! I was sufficiently confused to put a discussion point on adding codecov access to the dev guide and/or making it easier to know who to ask for help https://discuss.ropensci.org/t/staff-admin-team-codecov/2982 (apologies, I deleted the failed |
@ropensci-review-bot help |
Hello @maelle, here are the things you can ask me to do:
|
Date accepted: 2022-06-10
Due date for @kelshmo: 2021-11-19Submitting Author Name: Edward Wallace
Submitting Author Github Handle: @ewallace
Other Package Authors Github handles: @DimmestP
Repository: https://github.com/ewallace/tidyqpcr
Version submitted: 0.3.0
Submission type: Standard
Editor: @jooolia
Reviewers: @kelshmo
Archive: TBD
Version accepted: TBD
Scope
Please indicate which category or categories from our package fit policies this package falls under: (Please check an appropriate box below. If you are unsure, we suggest you make a pre-submission inquiry.):
Explain how and why the package falls under these categories (briefly, 1-2 sentences):
tidyqpcr is an R package that empowers scientists to conduct reproducible, flexible, and best-practice compliant quantitative polymerase chain reaction (qPCR) analysis.
tidyqpcr offers a standardised user interface and structure for qPCR analysis, within the tidyverse paradigm of spreadsheet-like rectangular data frames and generic functions that build up complex analyses in a series of simple steps.
Any molecular biologist or bioinformatician who needs to design or analyse a qPCR experiment.
Quantitative PCR is among the most common techniques in biological and biomedical re-
search, used for the quantification of DNA and RNA.
Standardised and open-source qPCR analysis pipelines will encourage best-practices in the reporting of qPCR results, improve the evaluation of qPCR experiments and ultimately lead to increased confidence in conclusions based on qPCR data.
Some open-source libraries for qPCR analysis are available, notably qpcR (Spiess, 2018) and pcr (Ahmed & Kim, 2018). qpcR is a feature rich qPCR analysis package relying on an object-oriented approach using S4 classes. pcr is a less extensive qPCR analysis package based on the tidyverse suite of generic data-science tools using the paradigm of tidy data (spreadsheet-like rectangular data frames). However, available packages either assume extensive prior R knowledge, overlook best-practices in qPCR experiments, or lack extensive documentation. There remains a need for a qPCR analysis package that integrates with the user-friendly tidyverse, encourages the use of MIQE best-practice compliant experimental design, and provides detailed example analysis pipelines as R vignettes.
(If applicable) Does your package comply with our guidance around Ethics, Data Privacy and Human Subjects Research?
Not applicable.
If you made a pre-submission inquiry, please paste the link to the corresponding issue, forum post, or other discussion, or @tag the editor you contacted.
We presented tidyqpcr on the rOpenSci discussion page which Stefanie Butland and Sean Hughes kindly responded to. In response to @seaaan ’s comments we improved the vignettes, stuck to a consistent function naming convention and added functionality to calculate ddCq. We intend to add further functionality in future versions including: support for absolute quantification, support for multiple targets per well, and enabling the use of the plater package.
In email correspondence with Stefanie, we believe Julia Gustavsen would be a perfect editor for our project as they reviewed Sean’s plater package. As for reviewers, we think someone with experience in conducting assays for RNA/DNA quantification and normalisation would be of benefit because of the emphasis on experimental design best-practices.
Technical checks
Confirm each of the following by checking the box.
This package:
Publication options
Do you intend for this package to go on CRAN?
Do you intend for this package to go on Bioconductor?
Do you wish to submit an Applications Article about your package to Methods in Ecology and Evolution?
Do you wish to submit an Applications Article about your package to Journal of Open Source Software?
We have included a paper.md file in the repository as per JOSS instructions to authors.
Code of conduct
The text was updated successfully, but these errors were encountered: