Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

scviR #2942

Closed vjcitn closed 1 year ago

vjcitn commented 1 year ago

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]'

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.

bioc-issue-bot commented 1 year ago

Hi @vjcitn

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: scviR
Date: 2022-10-01
Title: experimental inferface from R to scvi-tools
Version: 0.99.0
Authors@R: 
    c(person(
        "Vincent", "Carey", role = c("aut", "cre"),
        email = "stvjc@channing.harvard.edu",
        comment = c(ORCID = "0000-0003-4046-0063")
     )
    )
Description: This package defines interfaces from R to scvi-tools.  A
    vignette works through the totalVI tutorial for analyzing CITE-seq
    data.  Another vignette compares outputs of Chapter 12 of the
    OSCA book with analogous outputs based on totalVI quantifications.
    Future work will address other components of scvi-tools, with a 
    focus on building understanding of probabilistic methods based
    on variational autoencoders.
License: Artistic-2.0
Encoding: UTF-8
Depends: R (>= 4.2), basilisk, shiny, SingleCellExperiment
Imports: reticulate, BiocFileCache, utils, pheatmap,
    SummarizedExperiment, S4Vectors, limma, scater
Suggests: knitr, testthat, reshape2, ggplot2, rhdf5
VignetteBuilder: knitr
biocViews: Infrastructure, SingleCell, DataImport
RoxygenNote: 7.2.3
URL: https://github.com/vjcitn/scviR
BugReports: https://github.com/vjcitn/scviR/issues
bioc-issue-bot commented 1 year ago

A reviewer has been assigned to your package. Learn what to expect during the review process.

IMPORTANT: Please read this documentation for setting up remotes to push to git.bioconductor.org. It is required to push a version bump to git.bioconductor.org to trigger a new build.

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

bioc-issue-bot commented 1 year ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

On one or more platforms, the build results were: "ERROR, TIMEOUT, 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. This link will be 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/scviR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 6d93c49803cf7a245f90dcb91d7445329b8883ae

bioc-issue-bot commented 1 year ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

On one or more platforms, the build results were: "ERROR, skipped, 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. This link will be 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/scviR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 661e2c11a2b11f66b05aaef81348e226aff4d597

bioc-issue-bot commented 1 year ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

On one or more platforms, the build results were: "WARNINGS, 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. This link will be 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/scviR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 418fd7a59279c88e005e5d51d43c6e4d44985279

bioc-issue-bot commented 1 year ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

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. This link will be 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/scviR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 4caf4cc8e170924da4ac8ce101342a3912007491

bioc-issue-bot commented 1 year ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

Congratulations! The package built without errors or warnings on all platforms.

Please see the build report for more details. This link will be 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/scviR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

DarioS commented 1 year ago

scviR is an R package for interfacing to the single-cell modelling framework scVI-tools. It has no warnings nor errors from BiocCheck and R CMD check. The package name is unique. The DESCRIPTION file is suitably written. The NAMESPACE file has appropriate imports and exports. Installation was trouble-free Some issues:

Error in download.file(gzdat, targ) : download from 'https://mghp.osn.xsede.org/bir190004-bucket01/BiocScviR/pbmc_citeseq_5k10k.h5ad.gz' failed Timeout of 60 seconds was reached.

It also fails at the second chunk.
```r
> vae = get_citeseq_tutvae()
...    ...
trying URL 'https://repo.anaconda.com/miniconda/Miniconda3-py38_4.12.0-Windows-x86_64.exe'
Content type 'application/octet-stream' length 74002632 bytes (70.6 MB)
downloaded 67.0 MB
Timeout of 60 seconds was reached

Can this be changed to work for users far away from American servers and therefore slower transfer speeds?

vjcitn commented 1 year ago

Great comments. Could you try to build vignette after setting options(timeout=3600)? I will work on all your suggestions and get back to you here.

bioc-issue-bot commented 1 year ago

Received a valid push on git.bioconductor.org; starting a build for commit id: ed407353d2d2b5c69eab6b235b26269faf7c726f

bioc-issue-bot commented 1 year ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

Congratulations! The package built without errors or warnings on all platforms.

Please see the build report for more details. This link will be 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/scviR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 69361324d448b66543589cc5f9aed2a6ba2f496f

vjcitn commented 1 year ago

my responses are offset

scviR is an R package for interfacing to the single-cell modelling framework scVI-tools. It has no warnings nor errors from BiocCheck and R CMD check. The package name is unique. The DESCRIPTION file is suitably written. The NAMESPACE file has appropriate imports and exports. Installation was trouble-free Some issues:

I have added text suggesting use of options(timeout=3600)

Error in download.file(gzdat, targ) : download from 'https://mghp.osn.xsede.org/bir190004-bucket01/BiocScviR/pbmc_citeseq_5k10k.h5ad.gz' failed Timeout of 60 seconds was reached.

It also fails at the second chunk.
```r
> vae = get_citeseq_tutvae()
...    ...
trying URL 'https://repo.anaconda.com/miniconda/Miniconda3-py38_4.12.0-Windows-x86_64.exe'
Content type 'application/octet-stream' length 74002632 bytes (70.6 MB)
downloaded 67.0 MB
Timeout of 60 seconds was reached

Can this be changed to work for users far away from American servers and therefore slower transfer speeds?

I am unsure that we can do anything except advise longer timeout allowance. But we will look into options

I have not engaged with Seurat here although this seems to be the main "R" interface of concern to the scverse. I now mention in the main vignette that SCE and anndata are used.

A fair amount of additional prose has been added. Biological insights have not been sketched. I will be thinking about revisions that could be useful.

done

All the following are done

bioc-issue-bot commented 1 year ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

Congratulations! The package built without errors or warnings on all platforms.

Please see the build report for more details. This link will be 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/scviR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

DarioS commented 1 year ago

Thanks for the suggestion. Increasing the timeout successfully downloads the data. However, there's an error about its structure.

> adref = get_citeseq_5k10k_pbmcs()
C:\Users\dstr7320\AppData\Local/R/cache/R/BiocFileCache
  does not exist, create directory? (yes/no): yes
trying URL 'https://mghp.osn.xsede.org/bir190004-bucket01/BiocScviR/pbmc_citeseq_5k10k.h5ad.gz'
Content type 'application/octet-stream' length 51844928 bytes (49.4 MB)
downloaded 49.4 MB

adding rname 'C:\Users\dstr7320\AppData\Local\Temp\Rtmp210Bld/pbmc_citeseq_5k10k.h5ad'
Error in bfcrpath(ca, sub(".gz$", "", targ), action = "copy") : 
  not all 'rnames' found or unique.

Also, I don't think the updates are mirrored at vjcitn/scviR. How can I see them?

vjcitn commented 1 year ago

Thanks for trying. Yes, synchronization between git.bioconductor.org and my github repo is not occurring. This has to do with keeping pkgdown and github actions out of the git repo. I will try to straighten that out. I am concerned that the package won't build on windows. There is a special step concerning jaxlib in python with which I have not been able to succeed.

The problem you noted concerning rpath may concern the failed timeouts. You have extra entries in the BiocFileCache. The entries corresponding to the timeouts would have to be removed manually. I could add code to check for this and query the user about replacement.

vjcitn commented 1 year ago

all updates are pushed to extras branch at vjcitn/scviR ... however you should be able to pull all changes to the bioc source at https://git.bioconductor.org/packages/scviR

DarioS commented 1 year ago

It works except for Windows but it would be very difficult to figure out why it isn't working.

bioc-issue-bot commented 1 year ago

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.

lshep commented 1 year ago

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/vjcitn.keys is not empty), then no further steps are required. Otherwise, do the following:

  1. Add an SSH key to your github account
  2. Submit your SSH key to Bioconductor

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("scviR"). The package 'landing page' will be created at

https://bioconductor.org/packages/scviR

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.