Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

visiumStitched #3501

Open Nick-Eagles opened 2 months ago

Nick-Eagles commented 2 months 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 2 months ago

Hi @Nick-Eagles

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: visiumStitched
Title: Enable downstream analysis of Visium capture areas stitched together with
    Fiji
Version: 0.99.0
Date: 2024-07-19
Authors@R: 
    c(
    person("Nicholas J.", "Eagles", email = "nickeagles77@gmail.com",
    role = c("aut", "cre"), comment = c(ORCID = "0000-0002-9808-5254")),
    person("Leonardo", "Collado-Torres", role = c("ctb"), 
    email = "lcolladotor@gmail.com", comment = c(ORCID = "0000-0003-2140-308X"))
    )
Description: This package provides helper functions for working with
    multiple Visium capture areas that overlap each other. This package was
    developed along with the companion example use case data available from
    https://github.com/LieberInstitute/visiumStitched_brain. visiumStitched
    prepares SpaceRanger (10x Genomics) output files so you can stitch the
    images from groups of capture areas together with Fiji. Then visiumStitched
    builds a SpatialExperiment object with the stitched data and makes an
    artificial hexogonal grid enabling the seamless use of spatial clustering
    methods that rely on such grid to identify neighboring spots, such as
    PRECAST and BayesSpace. The SpatialExperiment objects created by
    visiumStitched are compatible with spatialLIBD, which can be used to build
    interactive websites for stitched SpatialExperiment objects. visiumStitched
    also enables casting SpatialExperiment objects as Seurat objects.
License: Artistic-2.0
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.2
Depends:
    R (>= 4.4),
    SpatialExperiment
Suggests: 
    BiocFileCache,
    BiocStyle,
    ggplot2,
    knitr,
    RefManageR,
    rmarkdown,
    sessioninfo,
    testthat (>= 3.0.0)
Config/testthat/edition: 3
VignetteBuilder: knitr
Imports:
    dplyr,
    DropletUtils,
    grDevices,
    imager,
    pkgcond,
    readr,
    rjson,
    S4Vectors,
    Seurat,
    spatialLIBD,
    stringr,
    SummarizedExperiment,
    xml2
biocViews: Software, Spatial, Transcriptomics, Transcription, GeneExpression,
    Visualization, DataImport
URL: https://github.com/LieberInstitute/visiumStitched
BugReports: https://support.bioconductor.org/tag/visiumStitched
LazyData: true
lcolladotor commented 2 months ago

PS This will be a package where both Nick and I will ultimately need Git push permissions on BioC. Thanks in advance!

lshep commented 1 month ago

I just tried to build locally and I get

Quitting from lines 383-399 [precast_k2] (visiumStitched.Rmd)
Error: processing vignette 'visiumStitched.Rmd' failed with diagnostics:
undefined columns selected
--- failed re-building ‘visiumStitched.Rmd’

SUMMARY: processing the following file failed:
  ‘visiumStitched.Rmd’

Error: Vignette re-building failed.
Execution halted
lcolladotor commented 1 month ago

Hi Lori,

Hmm, that's weird. It seems like you have access to an older version since https://github.com/LieberInstitute/visiumStitched/actions/runs/10290020036/job/28479030122 did complete R CMD build and other steps. Note that since Nick made this issue, we did have to make some updates.

Another tell sign is that the code chunk name you listed, changed from precast_k2 to precast_k2_stitched at https://github.com/LieberInstitute/visiumStitched/commit/15e19a4fe9dec99f29ba6bd193c64953cd246aa7#diff-875fd975531b65ba1343b24ad76faffbcc69d119601a74ac0734833a6bb07326L382.

Note that we haven't bumped the version number from 0.99.0 since the SBP hasn't been run yet and from previous experience, @bioc-issue-bot will complain that the version number is not 0.99.0 for the first run. Maybe we should bump the version number though (say 0.99.1)?

Best, Leo

lshep commented 1 month ago

indeed. I shall try again.

bioc-issue-bot commented 1 month ago

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

bioc-issue-bot commented 1 month ago

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: macOS 12.7.1 Monterey: visiumStitched_0.99.0.tar.gz Linux (Ubuntu 22.04.3 LTS): visiumStitched_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/visiumStitched to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

lcolladotor commented 1 month ago

Hi @Nick-Eagles,

Have you had a chance to look into resolving the issue(s) with your Bioconductor Support account (watched tags) + Bioconductor email support subscription?

Remember that once you have done so, you have to bump the package version, and push to both https://github.com/LieberInstitute/visiumStitched as well as the Bioconductor git server (git.bioconductor.org). See the notes on how to do this from the last link in the automated message above my comment. Doing this, will trigger a new SBP (Single Package Builder) run, which if successful, will remove the ERROR tag on this issue, which is needed for the review to keep moving.

Best, Leo

bioc-issue-bot commented 1 month ago

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

bioc-issue-bot commented 1 month ago

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: "TIMEOUT". 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): visiumStitched_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/visiumStitched 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 month ago

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

bioc-issue-bot commented 1 month ago

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): visiumStitched_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/visiumStitched 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 month ago

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): visiumStitched_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/visiumStitched 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 month ago

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

bioc-issue-bot commented 1 month ago

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): visiumStitched_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/visiumStitched 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 month ago

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

bioc-issue-bot commented 1 month ago

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): visiumStitched_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/visiumStitched 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 month ago

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

bioc-issue-bot commented 1 month ago

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): visiumStitched_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/visiumStitched to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

lcolladotor commented 1 month ago

Hi @lshep,

Right now the SBP at http://bioconductor.org/spb_reports/visiumStitched_buildreport_20240820163605.html reported a warning since R CMD check took longer than 10 min to run.

* checking examples ... [237s/243s] OK
Examples with CPU (user + system) or elapsed time > 5s
                      user system elapsed
build_spe           76.262  7.230  85.155
spe_to_seurat       32.023  3.932  36.406
add_array_coords    23.551  6.906  30.879
prep_fiji_image     17.799  4.825  23.568
rescale_fiji_inputs 14.105  1.492  16.684
prep_fiji_coords    12.416  2.478  15.925
* checking for unstated dependencies in tests ... OK
* checking tests ...
  Running testthat.R [209s/213s]
 [209s/214s] OK
* checking for unstated dependencies in vignettes ... OK
* checking package vignettes ... OK
* checking running R code from vignettes ... SKIPPED
* checking re-building of vignette outputs ... SKIPPED
* checking PDF version of manual ... [3s/3s] OK
* DONE

Status: 1 NOTE
See
  /home/pkgbuild/packagebuilder/workers/jobs/3501/04736b337ce9ed8dae3c08b4a72baec88fda8e97/visiumStitched.Rcheck/00check.log
for details.

 WARNING: R CMD check exceeded 10 min requirement

However, at GitHub actions also on Linux we see a different story at https://github.com/LieberInstitute/visiumStitched/actions/runs/10478583431/job/29022282328#step:21:95

* checking examples ... OK
Examples with CPU (user + system) or elapsed time > 5s
                      user system elapsed
build_spe           48.161  1.715  50.384
add_array_coords    16.248  1.449  18.476
spe_to_seurat       15.939  0.388  20.562
prep_fiji_image      9.854  0.888  11.251
prep_fiji_coords     9.105  0.773  10.613
rescale_fiji_inputs  9.006  0.739  10.682
* checking for unstated dependencies in ‘tests’ ... OK
* checking tests ...
  Running ‘testthat.R’
 OK
* checking for unstated dependencies in vignettes ... OK
* checking package vignettes ... OK
* checking running R code from vignettes ... SKIPPED
* checking re-building of vignette outputs ... SKIPPED
* DONE

Status: 2 NOTEs
See
  ‘/__w/visiumStitched/visiumStitched/check/visiumStitched.Rcheck/00check.log’
for details.
── R CMD check results ────────────────────────────── visiumStitched 0.[99](https://github.com/LieberInstitute/visiumStitched/actions/runs/10478583431/job/29022282328#step:21:100).5 ────
Duration: 8m 36.9s

On GHA the total run time is less than 10 min, but also, examples such as build_spe() took 50 seconds whereas on SBP it took 85 seconds (70% higher).

https://contributions.bioconductor.org/long-tests.html doesn't seem like it'd be helpful for this scenario.

Do you have any suggestions on how to proceed? We could put some examples, say, the ones for build_spe() under a dontrun, as they are similar in nature to the tests for that function.

Thanks, Leo

lshep commented 1 month ago

Its less than 10 min but not by much at 8 min 37 sec . Finding ways to reduce the time would be beneficial. As long as any exported function is run in either test or examples so that it can be run/checked at least once.

lcolladotor commented 1 month ago

Ok! Thanks Lori!

bioc-issue-bot commented 1 month ago

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

bioc-issue-bot commented 1 month ago

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): visiumStitched_0.99.6.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/visiumStitched 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 month ago

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

bioc-issue-bot commented 1 month ago

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): visiumStitched_0.99.7.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/visiumStitched to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

lcolladotor commented 1 month ago

Hi,

I see that on version 0.99.7 @Nick-Eagles was able to bring down R CMD check by nearly 1 minute (to 7 min 47 secs) based on numbers from GitHub actions, though it still triggers the 10 min warning on SBP.

* checking examples ... OK
Examples with CPU (user + system) or elapsed time > 5s
                      user system elapsed
build_spe           39.727  0.528  40.249
add_array_coords    16.870  1.490  20.709
rescale_fiji_inputs  8.256  0.664  10.272
spe_to_seurat        8.032  0.294  16.307
* checking for unstated dependencies in ‘tests’ ... OK
* checking tests ...
  Running ‘testthat.R’
 OK
* checking for unstated dependencies in vignettes ... OK
* checking package vignettes ... OK
* checking running R code from vignettes ... SKIPPED
* checking re-building of vignette outputs ... SKIPPED
* DONE

Status: 2 NOTEs
See
  ‘/__w/visiumStitched/visiumStitched/check/visiumStitched.Rcheck/00check.log’
for details.
── R CMD check results ────────────────────────────── visiumStitched 0.99.7 ────
Duration: 7m 46.4s

The above was taken from https://github.com/LieberInstitute/visiumStitched/actions/runs/10532150505/job/29185703583#step:21:116.

I see at https://github.com/LieberInstitute/visiumStitched/compare/04736b3..edda4cb that Nick mostly used exists() and a file to save data that is re-used across multiple examples. He also deleted one test and in another use uses a smaller subset of data (100 genes).

Does this seem enough @lshep? Hm... we could delete https://github.com/LieberInstitute/visiumStitched/blob/devel/tests/testthat/test-build_spe.R since most of that code seems to be used on the example for build_spe().

Best, Leo

bioc-issue-bot commented 3 weeks ago

A reviewer has been assigned to your package for an indepth review. Please respond accordingly to any further comments from the reviewer.

bioc-issue-bot commented 3 weeks ago

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

bioc-issue-bot commented 3 weeks ago

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): visiumStitched_0.99.8.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/visiumStitched to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.