Bioconductor / Contributions

Contribute Packages to Bioconductor
131 stars 33 forks source link

Submission of the tidyomics package #3268

Closed william-hutchison closed 4 months ago

william-hutchison commented 5 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 5 months ago

Hi @william-hutchison

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: tidyomics
Title: Easily install and load the tidyomics ecosystem
Version: 0.99.1
Authors@R: c(
    person(given = "Stefano",
 family = "Mangiola",
 role = c("aut", "cre"),
 email = "mangiolastefano@gmail.com",
 comment = c(ORCID = "0000-0001-7474-836X")),
    person(given = "Michael",
 family = "Love",
 role = c("aut"),
 email = "michaelisaiahlove@gmail.com",
 comment = c(ORCID = "0000-0001-8401-0545")),
    person(given = "William",
 family = "Hutchison",
 role = c("aut"),
 email = "hutchison.w@wehi.edu.au",
 comment = c(ORCID = "0009-0001-6242-4269"))
       )
Description: The tidyomics ecosystem is a set of packages for ’omic data analysis that work 
    together in harmony; they share common data representations and API design, consistent with the
    tidyverse ecosystem. The tidyomics package is designed to make it easy to install and load core 
    packages from the tidyomics ecosystem with a single command.
License: MIT + file LICENSE
URL: https://github.com/tidyomics/tidyomics
BugReports: https://github.com/tidyomics/tidyomics/issues
Depends:
    R (>= 4.2)
Imports:
    tidySummarizedExperiment,
    tidySingleCellExperiment,
    tidyseurat,
    tidybulk,
    plyranges,
    nullranges,
    purrr, 
    rlang, 
    stringr,
    cli,
    utils
Suggests:
    tidyr,
    dplyr, 
    tibble, 
    ggplot2,
    mockr (>= 0.2.0),
    knitr (>= 1.41),
    rmarkdown (>= 2.20),
    testthat (>= 3.1.6)
VignetteBuilder:
    knitr
Biarch: true
biocViews: AssayDomain, Infrastructure, RNASeq, DifferentialExpression, GeneExpression, Normalization, Clustering, QualityControl, Sequencing, Transcription, Transcriptomics
Config/testthat/edition: 3
Encoding: UTF-8
RoxygenNote: 7.2.3
bioc-issue-bot commented 5 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 5 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: tidyomics_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/tidyomics to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 5 months ago

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

bioc-issue-bot commented 5 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: "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: macOS 12.7.1 Monterey: tidyomics_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/tidyomics to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

william-hutchison commented 5 months ago

Hello, this is a small package with the purpose of installing and loading other packages in our software collection. In our minds, it would be ideal for the user to install all packages in the collection with: BiocManager::install("tidyomics")

and then load all packages with: library(tidyomcis)

In the same manner as the tidyverse package does for the tidyverse software collection. We are submitting the tidyomics package to Bioconductor as most packages in the collection are also in Bioconductor. The three warnings currently produced are a result of the function of the package:

Let me know if you would like to see any changes to this package or if you have any comments. Thank you for considering tidyomics for inclusion in Bioconductor.

Kind regards, William

lshep commented 4 months ago

I'm confused in the vignette at why plyinteractions and tidySpatialExperiment are not able to automatic installation as they have been accepted into Bioconductor? We don't endorse advertising install packages from github or using packages that are not in CRAN or Bioconductor so we would recommend removing 'tidyof' until it is officially submitted to CRAN or Bioconductor.

bioc-issue-bot commented 4 months ago

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

william-hutchison commented 4 months ago

Hi @lshep, thank you for your feedback.

I have updated the tidySpatialExperiment installation method to BiocManager now that the package is in Bioconductor and have removed GitHub installation instruction for tidytof.

Although plyinteractions, tidytof and tidySpatialExperiment are all solid packages, they are very new. Our idea is to reserve automatic installation for the most mature packages in our tidyomics ecosystem.

Let me know if you would like to see any further changes.

Kind regards, William

bioc-issue-bot commented 4 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: "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): tidyomics_0.99.3.tar.gz macOS 12.7.1 Monterey: tidyomics_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/tidyomics to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 4 months ago

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

lshep commented 4 months ago

man

vignette

william-hutchison commented 4 months ago

Thank you for your advice. I am occupied with a different project for the next few days, but I will make these changes as soon as possible - probably by mid-next week.

bioc-issue-bot commented 4 months ago

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

bioc-issue-bot commented 4 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: "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): tidyomics_0.99.7.tar.gz macOS 12.7.1 Monterey: tidyomics_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/tidyomics to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

william-hutchison commented 4 months ago

Hi @lshep, I have made all requested changes to the tidyomics package. Let me know if you have any further suggestions. Thanks again.

lshep commented 4 months ago

Thanks

bioc-issue-bot commented 4 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 4 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/william-hutchison.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("tidyomics"). The package 'landing page' will be created at

https://bioconductor.org/packages/tidyomics

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.