Skip to content
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

sosta #3584

Open
10 tasks done
sgunz opened this issue Sep 20, 2024 · 7 comments
Open
10 tasks done

sosta #3584

sgunz opened this issue Sep 20, 2024 · 7 comments
Assignees
Labels
2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place OK

Comments

@sgunz
Copy link

sgunz commented Sep 20, 2024

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 understand that by submitting my package to Bioconductor,
    the package source and all review commentary are visible to the
    general public.

  • I have read the Bioconductor Package Submission
    instructions. My package is consistent with the Bioconductor
    Package Guidelines.

  • I understand Bioconductor Package Naming Policy and acknowledge
    Bioconductor may retain use of package name.

  • 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.

  • My package addresses statistical or bioinformatic issues related
    to the analysis and comprehension of high throughput genomic data.

  • 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.

  • 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:

  • The 'devel' branch for new packages and features.
  • The stable 'release' branch, made available every six
    months, for bug fixes.
  • Bioconductor version control using Git
    (optionally via GitHub).

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
Copy link
Collaborator

Hi @sgunz

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: sosta
Title: A package for the analysis of anatomical tissue structures in spatial omics data
Version: 0.99.0
Authors@R: c(
    person("Samuel", "Gunz", , "[email protected]", role = c("aut", "cre"),
 comment = c(ORCID = "0000-0002-8909-0932")),
    person("Mark D.", "Robinson", role=c("aut", "fnd"), 
	    email="[email protected]"))
Description: `sosta` (Spatial Omics STructure Analysis) is a package for analyzing
    spatial omics data to explore tissue organization at the anatomical structure level.
    It reconstructs morphologically relevant structures based on molecular features 
    or cell types. It further calculates a range of structural and shape metrics
    to quantitatively describe tissue architecture. The package is designed to integrate 
    with other packages for the analysis of spatial (omics) data.
License: GPL (>= 3) + file LICENSE
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.2
URL: https://github.com/sgunz/sosta, https://sgunz.github.io/sosta/
BugReports: https://github.com/sgunz/sosta/issues
biocViews: Software, Spatial, Transcriptomics, Visualization
Imports: 
    terra,
    sf,
    smoothr,
    spatstat.explore,
    spatstat.geom,
    SpatialExperiment,
    dplyr,
    ggplot2,
    patchwork,
    SummarizedExperiment,
    stats,
    rlang
Suggests:
    knitr,
    rmarkdown,
    ggspavis,
    BiocStyle,
    imcdatasets,
    ggfortify,
    tidyr
VignetteBuilder: knitr

@bioc-issue-bot bioc-issue-bot added the 1. awaiting moderation submitted and waiting clearance to access resources label Sep 20, 2024
@lshep lshep added the pre-check passed pre-review performed and ready to be added to git label Sep 24, 2024
@bioc-issue-bot
Copy link
Collaborator

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 bioc-issue-bot added pre-review on bioconductor git and access to on demand build but not assigned reviewer until build report clean and removed 1. awaiting moderation submitted and waiting clearance to access resources pre-check passed pre-review performed and ready to be added to git labels Sep 24, 2024
@bioc-issue-bot
Copy link
Collaborator

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 24.04.1 LTS): sosta_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
[email protected]:packages/sosta to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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 24.04.1 LTS): sosta_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
[email protected]:packages/sosta to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@bioc-issue-bot bioc-issue-bot added OK and removed ERROR labels Sep 26, 2024
@lshep lshep added 2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place and removed pre-review on bioconductor git and access to on demand build but not assigned reviewer until build report clean labels Sep 26, 2024
@bioc-issue-bot
Copy link
Collaborator

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

@jianhong
Copy link

Package 'sosta' Review

Thank you for submitting your package to Bioconductor. The package passed check and build. However there are several things need to be fixed. Please try to answer the comments line by line when you are ready for a second review.
Code: Note: please consider; Important: must be addressed.

The DESCRIPTION file

  • Important: Depends field is not found in DESCRIPTION.
  • Important: R version is not clear in DESCRIPTION.

The NAMESPACE file

  • Important: Selective imports using importFrom instead of import all with import.
    • in line 20 import(SpatialExperiment)
    • in line 21 import(sf)
    • in line 22 import(spatstat.explore)
    • in line 23 import(spatstat.geom)

General package development

R code

  • NOTE: :: is not suggested in source code unless you can make sure all the packages are imported. Some people think it is better to keep ::. However, please be aware that you will need to manually double-check the imported items if you make any changes to the DESCRIPTION file during development. My suggestion is to remove one or two repetitions to trigger the dependency check.
    • In file R/reconstructShapePPP.R:
      • at line 118 found ' dplyr::filter(.data$value > max(.data$value) / 250) |>'
      • at line 125 found ' p <- patchwork::wrap_plots(den_im, den_hist, ncol = 2) +'
      • at line 126 found ' patchwork::plot_annotation('
      • at line 309 found ' res <- parallel::mclapply(sample_images, function(x) {'
      • at line 322 found ' res <- dplyr::bind_rows(res)'
      • at line 337 found ' plot(patchwork::wrap_plots(p1, p2, ncol = 2))'
    • In file R/shapeMetricsFromSF.R:
      • at line 63 found ' smooth_poly <- smoothr::smooth(sf::st_boundary(sfPoly),'
      • at line 71 found ' smooth_df <- as.data.frame(sf::st_coordinates(smooth_poly))'
      • at line 126 found ' perimeter <- sf::st_length(sf::st_boundary(sfPoly))'
      • at line 128 found ' radicand <- perimeter^2 - 16 * sf::st_area(sfPoly)'
    • In file R/utils.R:
      • at line 36 found ' terra::ext(r) <- c('
  • Important: Fix the TODO list.
    • In file R/reconstructShapePPP.R:
      • at line 29 found ' # TODO: Error when threshold is too small'
      • at line 254 found ' # TODO: do.call(rbind, a)'
    • In file R/utils.R:
      • at line 215 found ' # TODO: this could be improved'
  • NOTE: Functional programming: code repetition.
    • repetition in findIntensityThreshold, reconstructShapeDensityImage, and shapeIntensityImage
      • in findIntensityThreshold
        • line 3: if (is.null(bndw))
        • line 4: bndw <- bw.diggle(ppp)
        • line 5: den_df <- as.data.frame(density(ppp, sigma = bndw, dimyx = dimyx,
        • line 6: positive = TRUE))
      • in reconstructShapeDensityImage
        • line 5: pp_sel <- subset(pp, marks %in% mark_select)
        • line 6: dimyx <- getDimXY(pp_sel, dim)
        • line 7: if (is.null(bndw))
        • line 8: bndw <- bw.diggle(pp_sel)
      • in shapeIntensityImage
        • line 5: pp.islet <- subset(pp, marks %in% mark_select)
        • line 6: dimyx <- getDimXY(pp.islet, dim)
        • line 7: if (is.null(bndw))
        • line 8: bndw <- bw.diggle(pp.islet)
        • line 9: im_df <- as.data.frame(density.ppp(pp.islet, sigma = bndw,
        • line 10: dimyx = dimyx, positive = TRUE))

Documentation

  • Important: Vignette should have an Installation section.
    • rmd file vignettes/IMC_DiabetesIslets_Vignette.Rmd
  • Important: Please include Bioconductor installation instructions using BiocManager.
    • rmd file vignettes/IMC_DiabetesIslets_Vignette.Rmd
  • Important: Ensure the news file is updated to the latest version available.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place OK
Projects
None yet
Development

No branches or pull requests

4 participants