Closed MicTott closed 2 months ago
Hi @MicTott
Thanks for submitting your package. We are taking a quick look at it and you will hear back from us soon.
The DESCRIPTION file for this package is:
Package: SpotSweeper
Title: SpotSweeper
Version: 0.99.0
Date: 2023-10-30
Authors@R:
person("Michael", "Totty", ,"mictott@gmail.com", role = c("aut", "cre"),
comment = c(ORCID = "0000-0002-9292-8556"))
Description: Spatially-aware quality control software for detecting and removing low quality spots in spot-based spatial transcritpomics methods, such as 10x Visium.
License: MIT + file LICENSE
URL: https://github.com/MicTott/SpotSweeper, https://mictott.github.io/SpotSweeper/
BugReports: https://support.bioconductor.org/tag/SpotSweeper
biocViews:
Software,
Spatial,
Transcriptomics,
QualityControl,
GeneExpression,
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
Depends:
R (>= 4.3)
Imports:
SpatialExperiment,
SummarizedExperiment,
BiocNeighbors,
SingleCellExperiment,
stats,
BiocParallel,
MASS,
dbscan
Suggests:
escheR,
knitr,
scuttle,
STexampleData,
ggpubr,
testthat
Config/testthat/edition: 3
VignetteBuilder: knitr
LazyData: true
Your package has been added to git.bioconductor.org to continue the pre-review process. A build report will be posted shortly. Please fix any ERROR and WARNING in the build report before a reviewer is assigned or provide a justification on why you feel the ERROR or WARNING should be granted an exception.
IMPORTANT: Please read this documentation for setting up remotes to push to git.bioconductor.org. All changes should be pushed to git.bioconductor.org moving forward. It is required to push a version bump to git.bioconductor.org to trigger a new build report.
Bioconductor utilized your github ssh-keys for git.bioconductor.org access. To manage keys and future access you may want to active your Bioconductor Git Credentials Account
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Single Package Builder.
On one or more platforms, the build results were: "ERROR". This may mean there is a problem with the package that you need to fix. Or it may mean that there is a problem with the build system itself.
Please see the build report for more details.
The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 22.04.3 LTS): SpotSweeper_0.99.0.tar.gz macOS 12.7.1 Monterey: SpotSweeper_0.99.0.tar.gz
Links above active for 21 days.
Remember: if you submitted your package after July 7th, 2020,
when making changes to your repository push to
git@git.bioconductor.org:packages/SpotSweeper
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Received a valid push on git.bioconductor.org; starting a build for commit id: ec0a2e9bb873d3de0c0ddeaf9cfa4c83da596f0e
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Single Package Builder.
Congratulations! The package built without errors or warnings on all platforms.
Please see the build report for more details.
The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 22.04.3 LTS): SpotSweeper_0.99.1.tar.gz
Links above active for 21 days.
Remember: if you submitted your package after July 7th, 2020,
when making changes to your repository push to
git@git.bioconductor.org:packages/SpotSweeper
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
A reviewer has been assigned to your package for an indepth review. Please respond accordingly to any further comments from the reviewer.
Hi @MicTott
Thanks for submitting SpotSweeper :tada:! Below is my review of your package. Please reply here if anything is unclear or needs any further explanation.
What next?
Please address the comments as best as you can. When you are ready for me to check the package again please reply to let me know with a summary of changes you have made or any other responses. You can use the "Quote reply" option in the ...
menu on this comment to reply directly to my points below.
Luke
Key: :rotating_light: Required :warning: Recommended :green_circle: Optional :question: Question
BiocCheck::BiocCheck()
in the build report and address as many as possibleTitle
field should be a one line description of the package, not just the package nameTitle
you may want to consider expandingDescription
which can be a short paragraphLazyData: False
R (>= 4.4.0)
modified_z
is different to the other functions, I can see why but maybe think about if you can make them consistentimport()
for some packages, please consider if this is necessary or if you can use importFrom()
instead (especially for {MASS})NEWS
file (and ideally keep it up to date as you make changes)```r
without the {}
instead of setting eval=FALSE
BiocStyle
package for formattingeval = requireNamespace('SpotSweeper')
, the pacakge will always be available when the vignette is being builtseq_along()
/seq_len()
instead of 1:...
for
loops can be replaced with apply()
functions. Where possible, any for
loops that are kept should pre-allocate space for results rather than growing an object inside the loop.BPPARAM
argument that accepts a BiocParallel
object. The default should be bpparam()
or SerialParam()
."k18"
rather than paste0("k", 18)
Received a valid push on git.bioconductor.org; starting a build for commit id: 09175a979b1adb409ad4967da7e263c4be312d40
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Single Package Builder.
On one or more platforms, the build results were: "skipped, ERROR". This may mean there is a problem with the package that you need to fix. Or it may mean that there is a problem with the build system itself.
Please see the build report for more details.
The following are build products from R CMD build on the Single Package Builder: ERROR before build products produced.
Links above active for 21 days.
Remember: if you submitted your package after July 7th, 2020,
when making changes to your repository push to
git@git.bioconductor.org:packages/SpotSweeper
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Received a valid push on git.bioconductor.org; starting a build for commit id: 9a290e8fc81e2e728435e31867d2424abd9acef5
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Single Package Builder.
On one or more platforms, the build results were: "WARNINGS". This may mean there is a problem with the package that you need to fix. Or it may mean that there is a problem with the build system itself.
Please see the build report for more details.
The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 22.04.3 LTS): SpotSweeper_0.99.3.tar.gz
Links above active for 21 days.
Remember: if you submitted your package after July 7th, 2020,
when making changes to your repository push to
git@git.bioconductor.org:packages/SpotSweeper
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Received a valid push on git.bioconductor.org; starting a build for commit id: a1de5add5e0f39707eeec1949d1d5e690d8cd2ad
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Single Package Builder.
Congratulations! The package built without errors or warnings on all platforms.
Please see the build report for more details.
The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 22.04.3 LTS): SpotSweeper_0.99.4.tar.gz
Links above active for 21 days.
Remember: if you submitted your package after July 7th, 2020,
when making changes to your repository push to
git@git.bioconductor.org:packages/SpotSweeper
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Hi @lazappi
Thanks so much for the feedback! Please see below where I've made all of the changes, the π¨ Required and β οΈ Recommended items with [-] were removed (e.g., modified_z
replaced with spatialEco::outliers
, removed BiocParallel
).
Please let me know if there is anything to fix before this upcoming BioC release.
All the best, Michael
Hi @MicTott
Thanks for submitting SpotSweeper π! Below is my review of your package. Please reply here if anything is unclear or needs any further explanation.
What next?
Please address the comments as best as you can. When you are ready for me to check the package again please reply to let me know with a summary of changes you have made or any other responses. You can use the "Quote reply" option in the
...
menu on this comment to reply directly to my points below.Luke
Review
Key: π¨ Required β οΈ Recommended π’ Optional β Question
General package development
- [X] β οΈ Please review the notes from
BiocCheck::BiocCheck()
in the build report and address as many as possiblDESCRIPTION file
- [X] π¨ The
Title
field should be a one line description of the package, not just the package name- [X] π’ After you update
Title
you may want to consider expandingDescription
which can be a short paragraph- [X] π¨ Bioconductor recommends setting
LazyData: False
- [X] π¨ The R dependency for the next release should be
R (>= 4.4.0)
NAMESPACE file
- [-] β οΈ The naming of
modified_z
is different to the other functions, I can see why but maybe think about if you can make them consistent- [X] β οΈ You use
import()
for some packages, please consider if this is necessary or if you can useimportFrom()
instead (especially for {MASS})The NEWS file
- [X] π¨ Please add at least one entry to the
NEWS
file (and ideally keep it up to date as you make changes)The CITATION file
- [X] β οΈ Currently you have a TODO for the bioRxiv citation, I would suggest removing this until it is available to avoid confusing users
Package data
- [-] π’ The included data file is ok according to the checks but you may be able to reduce the size by using compression (if you haven't already)
Documentation
README
- [X] π’ If you want to include text that is formatted as code but isn't meant to be run you can use
```r
without the{}
instead of settingeval=FALSE
- [X] π’ I think there are some examples here that aren't included in the vignette, you may want to consider adding/moving them there
Vignette
- [X] π¨ Please use the
BiocStyle
package for formatting- [X] π¨ Please include a table of contents
- [X] π¨ The vignette should have an Introduction section that includes motivation for inclusion in Bioconductor and comparison to similar packages (if applicable)
- [X] π¨ The vignetted should have an Installation section that uses Bioconductor installation instructions (NOT evaluated)
- [X] β οΈ The vignette is quite limited. Please consider expanding it to cover more of the functionality of the package including things like how to set parameters and interpret output.
- [X] π’ There is no need for
eval = requireNamespace('SpotSweeper')
, the pacakge will always be available when the vignette is being builtMan pages
- [-] π’ It is recommended to add a package man page
Unit tests
- [X] π¨ Please add some unit tests to cover a large part of the core functionality
Code
R
- [X] π¨ Please use
seq_along()
/seq_len()
instead of1:...
- [-] β οΈ Some code is repeated across the functions (such as selecting features), consider moving this to another function and resuing it
- [X] β οΈ Consider adding for validity checks for function arguments
- [X] π¨ Please check if any
for
loops can be replaced withapply()
functions. Where possible, anyfor
loops that are kept should pre-allocate space for results rather than growing an object inside the loop.- [-] π¨ Rather than an argument for the number of cores you should have a
BPPARAM
argument that accepts aBiocParallel
object. The default should bebpparam()
orSerialParam()
.- [X] π’ I think you should be able to just use
"k18"
rather thanpaste0("k", 18)
Third-party code
- [-] π¨ Please make sure you have followed the license for code included from other packages
- [x] π¨ The vignetted should have an Installation section that uses Bioconductor installation instructions (NOT evaluated)
You can write this section as though the package has been accepted so you don't need to update it after the package becomes available.
- [-] π¨ Rather than an argument for the number of cores you should have a
BPPARAM
argument that accepts aBiocParallel
object. The default should bebpparam()
orSerialParam()
.
Can you please explain why you decided to remove it? I guess you didn't need to do things in parallel?
- [-] π¨ Please make sure you have followed the license for code included from other packages
Can you please explain your response to this? I'm not sure if you didn't need to make any changes or if you removed the code from other packages?
Otherwise I am happy with the changes so should be able to accept this after you respond to these questions.
Received a valid push on git.bioconductor.org; starting a build for commit id: f68d043248ed1985a26cc33c92ccbe34b08f5b7d
Hi @lazappi,
You can write this section as though the package has been accepted so you don't need to update it after the package becomes available.
Done.
Can you please explain why you decided to remove it? I guess you didn't need to do things in parallel?
Yes the method currently is very quick, even on large datasets. And the speed improvement from parallelization was minor, so I've just removed it for now. I may add it back in later if needed.
Can you please explain your response to this? I'm not sure if you didn't need to make any changes or if you removed the code from other packages?
Sorry for the confusion - the only code I used from a different package was spatialEco::outliers
where I directly copied it to the function SpotSweeper::modified_z
. At the time, the package had been taken off CRAN and was unable to be imported. Since then the authors have updated the package so that it's back on CRAN. So I chose to remove the SpotSweeper::modified_z
and instead just directly use spatialEco::outliers
. Hopefully that makes sense to you.
Thanks again for the feedback! Please let me know if there is anything else.
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Single Package Builder.
Congratulations! The package built without errors or warnings on all platforms.
Please see the build report for more details.
The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 22.04.3 LTS): SpotSweeper_0.99.5.tar.gz
Links above active for 21 days.
Remember: if you submitted your package after July 7th, 2020,
when making changes to your repository push to
git@git.bioconductor.org:packages/SpotSweeper
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Ok, I'm happy with this. I will mark it as approved.
Your package has been accepted. It will be added to the Bioconductor nightly builds.
Thank you for contributing to Bioconductor!
Reviewers for Bioconductor packages are volunteers from the Bioconductor community. If you are interested in becoming a Bioconductor package reviewer, please see Reviewers Expectations.
Congratulations on getting {SpotSweeper} accepted into Bioconductor π! It can take a few days to be picked up by the build system but then it will be available in Bioconductor devel and next release.
Thank you for all your careful feedback @lazappi! Have a wonderful day.
The default branch of your GitHub repository has been added to Bioconductor's git repository as branch devel.
To use the git.bioconductor.org repository, we need an 'ssh' key to associate with your github user name. If your GitHub account already has ssh public keys (https://github.com/MicTott.keys is not empty), then no further steps are required. Otherwise, do the following:
See further instructions at
https://bioconductor.org/developers/how-to/git/
for working with this repository. See especially
https://bioconductor.org/developers/how-to/git/new-package-workflow/ https://bioconductor.org/developers/how-to/git/sync-existing-repositories/
to keep your GitHub and Bioconductor repositories in sync.
Your package will be included in the next nigthly 'devel' build (check-out from git at about 6 pm Eastern; build completion around 2pm Eastern the next day) at
https://bioconductor.org/checkResults/
(Builds sometimes fail, so ensure that the date stamps on the main landing page are consistent with the addition of your package). Once the package builds successfully, you package will be available for download in the 'Devel' version of Bioconductor using BiocManager::install("SpotSweeper")
. The package 'landing page' will be created at
https://bioconductor.org/packages/SpotSweeper
If you have any questions, please contact the bioc-devel mailing list (https://stat.ethz.ch/mailman/listinfo/bioc-devel); this issue will not be monitored further.
Update the following URL to point to the GitHub repository of the package you wish to submit to Bioconductor
Confirm the following by editing each check box to '[x]'
[X] I understand that by submitting my package to Bioconductor, the package source and all review commentary are visible to the general public.
[X] I have read the Bioconductor Package Submission instructions. My package is consistent with the Bioconductor Package Guidelines.
[X] I understand Bioconductor Package Naming Policy and acknowledge Bioconductor may retain use of package name.
[X] I understand that a minimum requirement for package acceptance is to pass R CMD check and R CMD BiocCheck with no ERROR or WARNINGS. Passing these checks does not result in automatic acceptance. The package will then undergo a formal review and recommendations for acceptance regarding other Bioconductor standards will be addressed.
[X] My package addresses statistical or bioinformatic issues related to the analysis and comprehension of high throughput genomic data.
[X] I am committed to the long-term maintenance of my package. This includes monitoring the support site for issues that users may have, subscribing to the bioc-devel mailing list to stay aware of developments in the Bioconductor community, responding promptly to requests for updates from the Core team in response to changes in R or underlying software.
[X] I am familiar with the Bioconductor code of conduct and agree to abide by it.
I am familiar with the essential aspects of Bioconductor software management, including:
For questions/help about the submission process, including questions about the output of the automatic reports generated by the SPB (Single Package Builder), please use the #package-submission channel of our Community Slack. Follow the link on the home page of the Bioconductor website to sign up.