Bioconductor / Contributions

Contribute Packages to Bioconductor
131 stars 33 forks source link

findIPs: a new package to detect influential points for feature rankings #3288

Closed ShuoStat closed 2 months ago

ShuoStat commented 4 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 4 months ago

Hi @ShuoStat

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:

Type: Package
Package: findIPs
Title: Influential Points Detection for Feature Rankings
Version: 0.99.0
Date: 2023-11-21
Authors@R: c(
    person("Shuo", "Wang", , "wangsures@foxmail.com", role = c("aut", "cre"),
 comment = c(ORCID = "0009-0000-0424-2160")),
    person("Junyan", "Lu", , "junyan.lu@uni-heidelberg.de", role = "aut")
  )
Description: Feature rankings can be distorted by a single case in the
    context of high-dimensional data. The cases exerts abnormal influence
    on feature rankings are called influential points (IPs). The package
    aims at detecting IPs based on case deletion and quantifies their
    effects by measuring the rank changes (DOI:10.48550/arXiv.2303.10516).
    The package applies a novel rank comparing measure using the adaptive
    weights that stress the top-ranked important features and adjust the
    weights to ranking properties.
License: GPL-3
URL: https://github.com/ShuoStat/findIPs
BugReports: https://github.com/ShuoStat/findIPs
Depends: 
    graphics,
    R (>= 4.0.0)
Imports: 
    BiocParallel,
    methods,
    stats,
    survival,
    utils
Suggests: 
    BiocStyle,
    knitr,
    rmarkdown,
    testthat
VignetteBuilder: 
    knitr
biocViews: GeneExpression, DifferentialExpression, Regression, Survival
Encoding: UTF-8
LazyData: FALSE
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
lshep commented 4 months ago

Please remove vignette.html and vignette.Rmd from the inst directory. Vignettes should be built automatically through R CMD build. Please also rename your vignette to something more meaningful (like your package name findIPs.Rmd) as a generic name can cause loading conflicts depending on other packages loaded in a users session.

ShuoStat commented 4 months ago

I have made corrections following your instructions in my git repository. Do I need to resubmit a new issue or continue with this issue?

lshep commented 4 months ago

You can continue with this issue. I will look at it shortly

lshep commented 4 months ago

The package currently does not interop with any standard Bioconductor classes. Can an example be added showing this interoperability?

ShuoStat commented 4 months ago

Thanks for your constructive comments. I added two examples to show the interoperability with the Bioconductor class (SummarizedExperiment and ExpressionSet classes). In addition, I added some argument checkings, e.g., 'method' in findIPs() and sumRanks(). The revised package wasa re-run with R CMD build, R CMD check, and BiocCheck() in BiocCheck package. Thanks

ShuoStat commented 4 months ago

Thanks and please do not hesitate to share me more suggestions to improve the package

bioc-issue-bot commented 3 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 3 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): findIPs_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 git@git.bioconductor.org:packages/findIPs to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 3 months ago

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

bioc-issue-bot commented 3 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 3 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): findIPs_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 git@git.bioconductor.org:packages/findIPs to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 3 months ago

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

bioc-issue-bot commented 3 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.3 LTS): findIPs_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/findIPs to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

Kayla-Morrell commented 3 months ago

@ShuoStat - Thank you for submitting to Bioconductor. Please see the initial review of the package below. The required changes must be made while the suggested changes do not have to be (though we strongly encourage them). Comment back here with updates that have been made and when the package is ready for a re-review.

General package development

DESCRIPTION

NAMESPACE

NEWS

Vignette

R code

Best, Kayla

ShuoStat commented 3 months ago

Dear Kayla,

I want to express my gratitude for taking the time to provide your insightful comments and suggestions regarding our package. Your input has been invaluable in enhancing its quality. As a result of your feedback, several modifications and corrections have been implemented:

General package development

DESCRIPTION

NAMESPACE

NEWS

Vignette

R code

I tried to use the multiples of 4 spaces for line indents, and the number of lines without 4 spaces reduces to 51 lines

Furthermore, I've corrected issues with the sumRanks() and plotRankScatters() functions, and updated the corresponding test_that script accordingly.
Thanks for your work, and do not hesitate to contact me if you have mmore comments.

Best wishes, Shuo Wang

Kayla-Morrell commented 3 months ago

@ShuoStat - In order to see the changes and produce a build report, please push a valid version bump to the DESCRIPTION file.

Best, Kayla

bioc-issue-bot commented 3 months ago

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

bioc-issue-bot commented 3 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.3 LTS): findIPs_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/findIPs to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

Kayla-Morrell commented 3 months ago

@ShuoStat - Thank you for making the necessary changes. I have looked everything over and I have just one requirement before I can accept the package. Please make this change and let me know when you are ready for a re-review.

NEWS

Best, Kayla

bioc-issue-bot commented 2 months ago

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

ShuoStat commented 2 months ago

Dear Kayla,

I have updated the NEWS following your suggestions. The updated version has been pushed to git.bioconductor.org.

NEWS

Thanks for all your work and have a nice day. Kind regard, Shuo Wang

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

Kayla-Morrell commented 2 months ago

@ShuoStat - Thank you for making the necessary changes. I have reviewed everything and it all looks good. I'm more than happy to accept the package.

Best, Kayla

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

ShuoStat commented 2 months ago

Dear Kayla,

I am happy to hear about that. and thanks for your contribution to this package.

Kind regard Shuo Wang

lshep commented 2 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/ShuoStat.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("findIPs"). The package 'landing page' will be created at

https://bioconductor.org/packages/findIPs

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.