Closed federicomarini closed 8 months ago
Hi @federicomarini
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: HCATonsilData
Title: Provide programmatic access to the tonsil cell atlas datasets
Version: 0.99.0
Authors@R: c(person("Ramon", "Massoni-Badosa", role = c("aut", "cre"),
email="ramon.massoni@cnag.crg.eu",
comment = c(ORCID = "0000-0001-7115-8145")),
person("Federico", "Marini", role = c("aut"),
email = "marinif@uni-mainz.de",
comment = c(ORCID = "0000-0003-3252-7758")),
person("Alan", "O'Callaghan", role = c("aut"),
email = "alan.ocallaghan@outlook.com")
)
Description: This package provides access to the scRNA-seq, scATAC-seq,
multiome, CITE-seq and spatial transcriptomics (Visium) data generated
by the tonsil cell atlas in the context of the Human Cell Atlas (HCA).
The data is provided via the Bioconductor project in the form of
SingleCellExperiments. Additionally, information on the whole compendium of
identified cell types is provided in form of a glossary.
License: MIT + file LICENSE
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
Imports:
ExperimentHub,
SingleCellExperiment,
HDF5Array,
SummarizedExperiment,
htmltools,
rmarkdown,
base64enc,
utils
Suggests:
knitr,
ggplot2,
testthat (>= 3.0.0),
iSEE,
BiocStyle
Config/testthat/edition: 3
VignetteBuilder: knitr
URL: https://github.com/massonix/HCATonsilData
BugReports: https://github.com/massonix/HCATonsilData/issues
biocViews: SingleCellData, ExperimentData, RNASeqData, ExperimentHub, SpatialData
Depends:
R (>= 4.3.0)
As a couple of notes, relevant to the submission process:
We are all set for the submission to the ExperimentHub of the newer batch of dataset - I guess it is meaningful to tag @lshep on this one.
Thanks in advance for the feedback that will be provided! Ramon & Federico
Hi!
Thanks Fede for starting this thread! I've been feeling much better, and I've been working all weekend on the package. I have documented how to download the new version of the RNA and spatial datasets, I have created the proper metadata.csv that specifies all the files to be uploaded to the Hub (RNA, Spatial), and I have sharpened the vignette.
Tomorrow first thing, I will start all the necessary process to upload everything to the Hub. I have blocked all week to finish that, and given that the package is mostly ready I'm confident that we will finish it in time.
We are aware that we submitted the package at the last minute, but our paper was accepted just 2 weeks ago, and we have had limited time to freeze and curate the dataset. Thank you very much in advance for understanding, and we'll do everything in our power to get it to submission.
Let us know when the data is uploaded to the hub and when the package is in a state properly using the hub interface for data retrieval.
I have implemented all of the reviews from @HelenaLC and @federicomarini. The final touches will come once we can access the data from the Hub. @lshep I uploaded all data files using AzureStor without errors, please let me know if you can see the files, thanks
Hi @lshep,
We applied all pre-review changes. We only got a note saying the the build is 5.1Mb, but we hope it's fine given that documentation is an essential part of an annotation package, and the images we provide are of great help to understand the dataset.
Please let us know how to proceed
Thanks
Ramon
As an additional note, we did try to compact a bit the images by rastering/lowering the resolution.
We also tried to proactively address some Warnings and Notes from BiocCheck, so I think it is now all ready for the official review round. Thanks @lshep for the quick reaction on the submission of the v2 files!
Federico
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 Build System.
On one or more platforms, the build results were: "ERROR, skipped". 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 Bioconductor Build System: 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/HCATonsilData
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: 8eb0e068a7cfa1ad819f1e6f553558d3edab4cf1
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Build System.
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 Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): HCATonsilData_0.99.1.tar.gz macOS 12.6.5 Monterey: HCATonsilData_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/HCATonsilData
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: 1364fcd67b79f984647e8375483281a56b4ba8a9
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Build System.
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 Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): HCATonsilData_0.99.2.tar.gz macOS 12.6.5 Monterey: HCATonsilData_0.99.2.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/HCATonsilData
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: e5db74d7feeb450442ed9941e6e3716a3a917f53
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Build System.
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 Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): HCATonsilData_0.99.3.tar.gz macOS 12.6.5 Monterey: HCATonsilData_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/HCATonsilData
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.
Overall really well written and very good documentation.
A few comments to look into/fix
vignette
[ ] even tho the code chunks are in an eval=F, they are shown and use Seurat and Signac. I would add these packages to the Suggest of the DESCRIPTION.
[ ] Also the code should be runnable if someone tries to run it. The
download_dir is not defined. You should show using a tempdir to define it and
remove the dir.create
call and then update the call accordingly
download_dir = tempdir()
destfile = file.path(download_dir, "TonsilAtlasSeuratATAC.tar.gz")
[ ] I tried to run the code in the eval=FALSE
but could not get it to
run. Please update with above comment and make sure its runnable.
Thanks Lori @lshep for the swift review, I am glad you find it already in good shape.
I will assist @massonix in editing the vignette (and co.) as you suggested.
Here's our reply point by point to the items listed above, and a note to some additional slight changes.
even tho the code chunks are in an eval=F, they are shown and use Seurat and Signac. I would add these packages to the Suggest of the DESCRIPTION.
Thanks for the suggestion. We were indeed trying to be parsimonious on the number of packages our package would need to install alongside itself, and having them as Suggests:
entries is likely the most considerate way of handling this.
Also the code should be runnable if someone tries to run it. The download_dir is not defined. You should show using a tempdir to define it and remove the dir.create call and then update the call accordingly download_dir = tempdir() destfile = file.path(download_dir, "TonsilAtlasSeuratATAC.tar.gz")
We replaced the hard coded path for the folder dedicated to downloading, using the tempdir()
location combined to file.path()
as suggested.
We are aware some of the chunks involving download operations might take a while to execute, and we added some heads up as a comment about the size of the expected downloaded file - We hope this can be useful to the readers when they plan to retrieve the dataset.
I tried to run the code in the eval=FALSE but could not get it to run. Please update with above comment and make sure its runnable.
While addressing the changes needed for the point above, we made sure to check all lines were ideally runnable, even if they are not evaluated as a chunk itself - albeit lenghty, all code chunks now run and work, should readers want to try any of them out, independently of the eval
parameter.
--
Additionally, we did some minor tweaks to the content of the vignette, and activated the CI/CD via GitHub Actions to have a better idea of the behavior of the package build/check on other systems and configurations.
As of now, there seems to be an issue in there so we could not directly check all systems as we hoped, but hope it will adjust in due time so we have everything already in place for that.
I am taking over for this as Ramon is relocating soon and has no full access to his old laptop and/or a powerful cabled connection - I hope it is fine for you as well @lshep
Received a valid push on git.bioconductor.org; starting a build for commit id: fd2fc36501087029e2c1df0d14a5bfec6e20d8a8
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Build System.
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 Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): HCATonsilData_0.99.4.tar.gz macOS 12.6.5 Monterey: HCATonsilData_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/HCATonsilData
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Section 5 of vignette
htmltools::includeHTML(
TonsilData_cellinfo_html("Tfr", display_plot = TRUE)
)
to work. It comes up with a file not found error. I had this issue with another package too and seems to be with my set up but it is unclear to me what system dependency or package I am missing to have this work correctly? Any ideas?
Section 6 of vignette
tempdir()
for examplesSection 5 of vignette I can't seem to get htmltools::includeHTML( TonsilData_cellinfo_html("Tfr", display_plot = TRUE) ) to work. It comes up with a file not found error. I had this issue with another package too and seems to be with my set up but it is unclear to me what system dependency or package I am missing to have this work correctly? Any ideas?
Hm, this is odd. The idea behind that chunk is that
TonsilData_cellinfo_html()
returns a character string with the location of the generated HTML page, while simultaneously opening it into a browser window. Alternatively, one can obtain as returned value the full HTML code (and ideally use that to embed it)htmltools::includeHTML()
shows how one can insert that page inside an existing report.If run correctly, this would give a small item in the vignette which looks like this:
I will leave the chunk as EVAL'd now and see whether something odd happens.
Section 6 of vignette zellkonverter should also be in the Suggests since it is used in the vignette. if this writes to disk make sure the file is a tempdir() for examples
Both very good points indeed - sorry we missed that.
zellkonverter
is now in the Suggests, and we have an intermediate step to create the filename intended to be used in the call to writeH5AD()
Received a valid push on git.bioconductor.org; starting a build for commit id: 5c04b5255809c6a9847b665e61f961edd5721d37
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Build System.
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 Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): HCATonsilData_0.99.5.tar.gz macOS 12.6.5 Monterey: HCATonsilData_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/HCATonsilData
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
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.
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/federicomarini.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("HCATonsilData")
. The package 'landing page' will be created at
https://bioconductor.org/packages/HCATonsilData
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.