Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

omada #2668

Closed BioSok closed 2 years ago

BioSok commented 2 years 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 years ago

Hi @BioSok

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: omada
Type: Package
Title: Machine learning tools for automated transcriptome 
    clustering analysis
Version: 0.99.0
Authors@R: person("Sokratis Kariotis", "Developer", role = c("aut", "cre"),
           email = "sokratiskariotis@gmail.com")
Description: An unsupervised machine learning toolkit for automated sample 
clustering of gene expression profiles. Offer various tools that provide machine
learning based answers to decisions that need to be taken during 
a clustering analysis
Depends:
    pdfCluster (>= 1.0-3),
    kernlab (>= 0.9-29),
    R (>= 4.1),
    fpc (>= 2.2-9),
    Rcpp (>= 1.0.7),
    diceR (>= 0.6.0),
    ggplot2 (>= 3.3.5),
    reshape (>= 0.8.8),
    clusterCrit (>= 1.2.8),
    clValid (>= 0.7),
    glmnet (>= 4.1.3),
    dplyr(>= 1.0.7)
Suggests:
    rmarkdown,
    knitr,
    testthat
License: GPL-3
Encoding: UTF-8
RoxygenNote: 7.1.2
VignetteBuilder: knitr
biocViews: Software, Clustering, RNASeq, GeneExpression
vjcitn commented 2 years ago

Thanks for your submission. I see in the vignette

partition.agreement.scores <- omada.analysis[[1]]
partition.agreement.plot <- omada.analysis[[2]]
feature.selection.scores <- omada.analysis[[3]]
feature.selection.plot <- omada.analysis[[4]]
cluster.voting.scores <- omada.analysis[[5]]
cluster.voting.cluster.memberships <- omada.analysis[[6]]
cluster.voting.metric.votes <- omada.analysis[[7]]
cluster.voting.k.votes <- omada.analysis[[8]]
cluster.voting.plot <- omada.analysis[[9]]
sample.memberships <- omada.analysis[[10]]
signature.feature.coefs <- omada.analysis[[11]]
signature.feature.plot <- omada.analysis[[12]]

This is not convenient for users. Please define a class that can manage this complexity for the user; join the mentoring program if this is not clear. Bioconductor infrastructure for gene set management (e.g., GSEABase or BiocSet) should be used to participate meaningfully in the ecosystem.

BioSok commented 2 years ago

Hey, thanks for the feedback. I have created a class, could you check if it's to your standards? Thanks!

vjcitn commented 2 years ago

It is getting a little better, but

# Extract results
stabilities.per.cluster <- existing.dataset.analysis[[1]]
maximum.stability <- existing.dataset.analysis[[2]]
average.stability <- existing.dataset.analysis[[3]]
simulated.dataset <- existing.dataset.analysis[[4]]

Automated clustering analysis: Omada

Using omada() along with a gene expression dataframe and an upper k (number of clusters to be considered) we can run the whole analysis toolkit to automate clustering decision making and produce the estimated optimal clusters.

# Running the whole cascade of tools inputting an expression dataset 
# and the upper k (number of clusters) to be investigated
omada.analysis <- omada(toy_genes, method.upper.k = 4)
# Plot results
omada.analysis$partition.agreement.plot
omada.analysis$feature.selection.plot
omada.analysis$cluster.voting.plot
omada.analysis$signature.feature.plot

is still not in line with how most bioconductor packages work. The extraction of results using [[i]] on existing.dataset.analysis is better accomplished with functions on the existing.dataset.analysis which could be an instance of an S3 or S4 class. We distinguish "getters" and "setters". You would define get_stabilities_per_cluster as a method on the analysis class.

Then with your plot calls via "$", you have an object class with omada.analysis as an instance; you would define, say the method "plot" with a parameter type that is one of "partition.agreement" or "feature.selection" and so forth.

BioSok commented 2 years ago

Hey! I have restructured the functions with getters as well as the vignette.

vjcitn commented 2 years ago

Bump the version number in DESCRIPTION whenever you commit a change to source.

BioSok commented 2 years ago

Bumped it to 0.99.1 from 0.99.0

bioc-issue-bot commented 2 years 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 2 years 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". 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/omada to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

BioSok commented 2 years ago

Hey @nturaga , it seems I don't have access to push to the repo as I'm getting:

FATAL: W any packages/omada s.kariotis DENIED by fallthru (or you mis-spelled the reponame) fatal: Could not read from remote repository.

Also, I submitted 2 packages few years ago and from the Bioconductor Git Credentials I can see I only have access to those.

nturaga commented 2 years ago

Hi, this should be fixed now. please try to push again.

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 years 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". 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/omada to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 years 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". 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/omada to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 years 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". 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/omada to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 years 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". 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/omada to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 years 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/omada to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 years ago

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

lshep commented 2 years ago

we are experiencing some issues with the newly added windows builder that is prevent the new build report from being posted. We are working on a remedy. We appreciate your patience and understanding.

bioc-issue-bot commented 2 years 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". 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/omada to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 years 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/omada to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 years 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/omada to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 years 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/omada to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 years 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/omada to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

nturaga commented 2 years ago

DESCRIPTION

Authors@R: person("Sokratis Kariotis", "Developer", role = c("aut", "cre"),
                     email = "sokratiskariotis@gmail.com"

build report

Please fix the following NOTEs

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 years 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". 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/omada to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 years 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/omada to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

BioSok commented 2 years ago

DESCRIPTION

  • Your name isn't "Developer" , so i'm not sure why the name of the person is listed this way.
Authors@R: person("Sokratis Kariotis", "Developer", role = c("aut", "cre"),
                     email = "sokratiskariotis@gmail.com"

build report

Please fix the following NOTEs

  • NOTE: Update R version dependency from 4.1 to 4.2.0.
  • Checking coding practice...

    • NOTE: Avoid 1:...; use seq_len() or seq_along()
    • NOTE: Avoid 'cat' and 'print' outside of 'show' methods
    • NOTE: Avoid using '=' for assignment and use '<-' instead
  • NOTE: Consider adding runnable examples to man pages that document exported objects.
  • NOTE: Consider adding a NEWS file, so your package news will be included in Bioconductor release announcements.

Fixed!

BioSok commented 2 years ago

DESCRIPTION

  • Your name isn't "Developer" , so i'm not sure why the name of the person is listed this way.
Authors@R: person("Sokratis Kariotis", "Developer", role = c("aut", "cre"),
                     email = "sokratiskariotis@gmail.com"

build report

Please fix the following NOTEs

  • NOTE: Update R version dependency from 4.1 to 4.2.0.
  • Checking coding practice...

    • NOTE: Avoid 1:...; use seq_len() or seq_along()
    • NOTE: Avoid 'cat' and 'print' outside of 'show' methods
    • NOTE: Avoid using '=' for assignment and use '<-' instead
  • NOTE: Consider adding runnable examples to man pages that document exported objects.
  • NOTE: Consider adding a NEWS file, so your package news will be included in Bioconductor release announcements.

Dear @nturaga , is there an update on the package review process? I am asking because we are trying to align its release to the relevant paper's submission. Thanks!

nturaga commented 2 years ago

@BioSok

Your package looks fine to accept. Please issue another build report.

One issue is that there is no sessionInfo() inside your vignette. Please include it.

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 years 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/omada to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 years 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/omada to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 years 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/omada to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years 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 2 years ago

The master branch of your GitHub repository has been added to Bioconductor's git repository.

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

https://bioconductor.org/packages/omada

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.