Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

VisiumIO #3254

Closed LiNk-NY closed 9 months ago

LiNk-NY commented 11 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 11 months ago

Hi @LiNk-NY

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: VisiumIO
Title: Import Visium data from the 10X Space Ranger pipeline
Version: 0.99.2
Authors@R:
    person("Marcel", "Ramos", , "marcel.ramos@roswellpark.org", role = c("aut", "cre"),
 comment = c(ORCID = "0000-0002-3242-0582"))
Description: The package allows users to readily import spatial data obtained
    from either the 10X website or from the Space Ranger pipeline.
    Supported formats include tar.gz, h5, and mtx files. Multiple files
    can be imported at once with *List type of functions. The package
    represents data mainly as SpatialExperiment objects.
License: Artistic-2.0
Depends: R (>= 4.4.0), TENxIO
Imports:
    BiocBaseUtils,
    BiocGenerics,
    BiocIO,
    jsonlite,
    methods,
    S4Vectors,
    SpatialExperiment,
    SummarizedExperiment
Suggests:
    BiocStyle,
    knitr,
    rmarkdown,
    tinytest
biocViews: Software, Infrastructure, DataImport, SingleCell, Spatial
VignetteBuilder: knitr
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
BugReports: https://github.com/waldronlab/VisiumIO/issues
URL: https://github.com/waldronlab/VisiumIO
bioc-issue-bot commented 10 months 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 10 months 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: VisiumIO_0.99.2.tar.gz Linux (Ubuntu 22.04.2 LTS): VisiumIO_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/VisiumIO to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 10 months ago

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

bioc-issue-bot commented 10 months 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.

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.2 LTS): VisiumIO_0.99.3.tar.gz macOS 12.7.1 Monterey: VisiumIO_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/VisiumIO to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 10 months ago

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

DarioS commented 9 months ago

The function code is well-designed with input type validation and the documentation is written clearly. Just one minor issue.

LiNk-NY commented 9 months ago

Hi Dario, @DarioS Thank you for the note. I would like to use camelCase but sample_ids is a familiar argument for SpatialExperiment users: https://github.com/drighelli/SpatialExperiment/blob/bb81804decd9cdbe93e436588ab8c8792b5a3b8d/R/SpatialExperiment.R#L207

This argument directly maps to the SpatialExperiment constructor and the format should be recognizeable.

Best regards, Marcel

DarioS commented 9 months ago

Ah, that makes sense. Consistency is more important than style.

bioc-issue-bot commented 9 months 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 9 months 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/LiNk-NY.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("VisiumIO"). The package 'landing page' will be created at

https://bioconductor.org/packages/VisiumIO

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.