Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

partCNV #2861

Closed rx-li closed 1 year ago

rx-li commented 1 year 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 1 year ago

Hi @rx-li

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: partCNV
Type: Package
Title: Infer locally aneuploid cells using single cell RNA-seq data
Version: 0.99.0
Authors@R: c(
    person(given="Ziyi", family="Li", email="zli16@mdanderson.org", role=c("aut", "cre", "ctb")),
    person(given="Ruoxing", family="Li", email="ruoxingli@outlook.com", role="ctb"))
Description: This package uses a statistical framework for rapid and accurate detection of aneuploid cells with local copy number deletion or amplification. Our method uses an EM algorithm with mixtures of Poisson distributions while incorporating cytogenetics information (e.g., regional deletion or amplification) to guide the classification (partCNV). When applicable, we further improve the accuracy by integrating a Hidden Markov Model for feature selection (partCNVH).
Imports: stats, data.table, depmixS4, Seurat, Matrix, GenomicRanges
Suggests: BiocStyle, rmarkdown, knitr, IRanges
VignetteBuilder: knitr
License: GPL-2
Encoding: UTF-8
LazyData: true
RoxygenNote: 7.2.1
biocViews: Software, CopyNumberVariation, HiddenMarkovModel
vjcitn commented 1 year ago

Thanks for this submission. It needs some work before we review. 1) example(partCNV) doesn't really do anything. 2) you include cytoband addresses that are 0 based, that come from UCSC, but Bioconductor already has cytobands for hg38 in a GRanges in AH53178, adhering to the 1-based convention of Bioconductor, 3) when I look at the vignette, the colors in the UMAP visualizations do not have a key visible.

rx-li commented 1 year ago

Dear Vince,

Thanks so much for the insights. I have updated the package:

  1. The examples should run normally now.
  2. I deleted the cytoband data, and use "AH53178" in AnnotationHub now.
  3. I added the axises back to the UMAP.

Please let me know if you have any questions.

Best regards, Ruoxing

On Tue, Dec 6, 2022 at 4:14 AM Vince Carey @.***> wrote:

Thanks for this submission. It needs some work before we review. 1) example(partCNV) doesn't really do anything. 2) you include cytoband addresses that are 0 based, that come from UCSC, but Bioconductor already has cytobands for hg38 in a GRanges in AH53178, adhering to the 1-based convention of Bioconductor, 3) when I look at the vignette, the colors in the UMAP visualizations do not have a key visible.

— Reply to this email directly, view it on GitHub https://github.com/Bioconductor/Contributions/issues/2861#issuecomment-1339086799, or unsubscribe https://github.com/notifications/unsubscribe-auth/ASV6ODXZFWF6P3NFMVV4BVDWL4GZNANCNFSM6AAAAAASN5A5RQ . You are receiving this because you were mentioned.Message ID: @.***>

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

ococrook commented 1 year ago

Hi @rx-li

Thanks for the submission the package looks interesting a useful. Having a first quick pass through the package there are some aspect that need addressing before a more detailed review.

Bioconductor objects:

Whilst we are happy for methods to also work on Seurat object we require that the package build on the BioC infrastructure. If I've understood your package correctly it could start from a SingeCellExperiment object instead? Do correct me if there a more appropriate object. I imagine getting your code to work with Bioc object will change quite a lot of the vignette and code so its worth addressing the issues first

Other issues:

Looking forward to including this package in the Bioc family

bioc-issue-bot commented 1 year ago

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

rx-li commented 1 year ago

Dear @ococrook,

Thanks so much for your review and comments. You are right about the SingleCellExperiment object. If we start from the SingeCellExperiment object, counts can be normalized and log transformed manually, and I have included the normalization method in the vignette.

For the other issues, please find the one-by-one responses below:

Thanks again for your help. Looking forward to your reply.

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

ococrook commented 1 year ago

Sorry did you have a look through the build report and fix the Errors? http://staging.bioconductor.org:8000/job/18410/

You also need to state the R version of the code.

ococrook commented 1 year ago

@rx-li

The package still builds with Errors, we can close the issue until you have time address these at which point we can re-open the issue if necessary?

rx-li commented 1 year ago

@ococrook I am so sorry that I overlooked the email regarding the issue. I will address it ASAP. Thanks so much.

bioc-issue-bot commented 1 year ago

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

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

ococrook commented 1 year ago

@rx-li

Are you subscribed to the mailing list?

lshep commented 1 year ago

I don't see the maintainer email registered. If you tried to register, there is normally a confirmation email sent. It can sometimes be marked as spam/junk. Please check those folders for the confirmation email.

bioc-issue-bot commented 1 year ago

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

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

ococrook commented 1 year ago

The package only cursorily engages with SingelCellExperiment as a passing comment. For the package to be accepted to Bioconductor it needs to be more carefully integrated into the workflow.

rx-li commented 1 year ago

Dear @ococrook

Thanks for your comment. I will add more steps on how to start from SingelCellExperiment.

Best regards, Ruoxing

ococrook commented 1 year ago

Brilliant, thank you!

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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/partCNV 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 year ago

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

bioc-issue-bot commented 1 year 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/partCNV 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 year ago

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

bioc-issue-bot commented 1 year 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/partCNV 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 year ago

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

bioc-issue-bot commented 1 year 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/partCNV 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 year ago

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

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

rx-li commented 1 year ago

Dear @ococrook,

Good afternoon.

I have added a function which can normalize the counts for a SingleCellExperiment object, and its results can be used in the analysis. Please let me know if anything else is needed.

Thanks, Ruoxing

ococrook commented 1 year ago

Great, thank you Ruoxing.

Can you add Bioconductor install instructions and then I can accept the package

bioc-issue-bot commented 1 year ago

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

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

rx-li commented 1 year ago

The install instructions are added. Thanks so much, @ococrook!

bioc-issue-bot commented 1 year 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.

rx-li commented 1 year ago

Dear @ococrook ,

Thanks for accepting our package.

I am wondering where I can access the Bioconductor webpage of the package. I saw that the package had been nightly built, but I did not find the URL for the package.

Best regards, Ruoxing

ococrook commented 1 year ago

Hi @rx-li,

It will appear it due course, it can take sometime for the maintainers to set-up the webpage. Youll be able to search here when it's ready: https://www.bioconductor.org/packages/devel/BiocViews.html#___Software. I suspect if should take a few more days.

Best wishes, Olly

lshep commented 1 year 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/rx-li.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("partCNV"). The package 'landing page' will be created at

https://bioconductor.org/packages/partCNV

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.