Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

MAI #2203

Closed Dekermanjian closed 3 years ago

Dekermanjian commented 3 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 3 years ago

Hi @Dekermanjian

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: MAI
Type: Package
Title: Mechanism-Aware Imputation
Version: 0.99.0
Authors@R: 
  c(person(given = "Jonathan",
 family = "Dekermanjian",
 role = c("aut", "cre"),
 email = "Jonathan.Dekermanjian@CUAnschutz.edu"),
    person(given = "Elin",
 family = "Shaddox",
 role = c("aut"),
 email = "Elin.Shaddox@CUAnschutz.edu"),
    person(given = "Debmalya",
 family = "Nandy",
 role = c("aut"),
 email = "Debmalya.Nandy@CUAnschutz.edu"),
   person(given = "Debashis",
 family = "Ghosh",
 role = c("aut"),
 email = "Debashis.Ghosh@CUAnschutz.edu"),
   person(given = "Katerina",
 family = "Kechris",
 role = c("aut"),
 email = "Katerina.Kechris@CUAnschutz.edu"))
Description: A two-step approach to imputing missing data in metabolomics.
    Where step 1 uses a random forest classifier to classify missing values as 
    either MCAR/MAR or MNAR. Step 2 imputes the missing values based on the 
    classified missing mechanisms, using the appropriate imputation algorithms. 
    MCAR/MAR tested and available imputation algorithms include Bayesian 
    Principle Component Analysis (BPCA), Multiple Imputation No-Skip K-Nearest 
    Neighbors (Multi_nsKNN), and random forest. The imputation algorihms that 
    are available and tested for MNAR values include nsKNN and a single 
    imputation approach for linear regression with a randomly right-censored 
    covariate, we developed a method for imputation of metabolites where 
    left-censoring is present.
License: GPL-3
Encoding: UTF-8
Imports:
    caret,
    parallel,
    doParallel,
    e1071,
    future.apply,
    future,
    missForest,
    pcaMethods,
    tidyverse,
    stats,
    utils
biocViews:
    Software,
    Metabolomics,
    StatisticalMethod,
    Classification
Suggests: 
    knitr,
    rmarkdown,
    testthat (>= 3.0.0)
VignetteBuilder: knitr
Config/testthat/edition: 3
bioc-issue-bot commented 3 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 3 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: "skipped, 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/MAI 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 years ago

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

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

LiNk-NY commented 3 years ago

Hi Jonathan, @Dekermanjian

Thank you for your submission. Unfortunately, at this time, we cannot accept a package that does not use existing Bioconductor infrastructure. See below.

Best regards, Marcel


MAI #2203

Dekermanjian commented 3 years ago

Hi Marcel, @LiNk-NY

I would like to revise MAI to be able to provide imputation functionality on summarized experiment classes.

bioc-issue-bot commented 3 years ago

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

bioc-issue-bot commented 3 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/MAI 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 years ago

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

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

Dekermanjian commented 3 years ago

Hi Marcel, @LiNk-NY I just wanted to let you know that I have added the functionality to impute data included as assay in the SummarizedExperiment class.

LiNk-NY commented 3 years ago

Hi Jonathan, @Dekermanjian

Thanks for making those changes. Please see the review below.

Best regards, Marcel


MAI #2203

DESCRIPTION

NAMESPACE

vignettes

R

man

tests

Dekermanjian commented 3 years ago

Thank you @LiNk-NY

I will make the changes you have listed.

Marcel, for the 1:n portion, in the code I have seq_along for all of them but the BiocCheck is still saying that they are 1:n. Am I missing something?

LiNk-NY commented 3 years ago

Hi Jonathan, @Dekermanjian

Please see the output of BiocCheck::BiocCheck(".")

* Checking coding practice...
    * NOTE: Avoid 1:...; use seq_len() or seq_along()
      Found in files:
        Altered_mm_algorithm.R (line 17, column 46)
        Altered_mm_algorithm.R (line 18, column 41)
        Altered_mm_algorithm.R (line 23, column 53)
        Altered_mm_algorithm.R (line 41, column 32)
        Altered_mm_algorithm.R (line 50, column 16)
        Altered_mm_algorithm.R (line 82, column 32)
        Altered_mm_algorithm.R (line 90, column 26)
        Altered_mm_algorithm.R (line 132, column 55)
        Altered_mm_algorithm.R (line 160, column 25)
        Altered_mm_algorithm.R (line 172, column 25)
        MAI.R (line 71, column 23)
        nsKNN.R (line 16, column 43)
        nsKNN.R (line 18, column 24)
        nsKNN.R (line 29, column 55)
        nsKNN.R (line 32, column 55)
        nsKNN.R (line 40, column 25)
        nsKNN.R (line 78, column 25)
        nsKNN.R (line 80, column 36)
        nsKNN.R (line 83, column 29)
        nsKNN.R (line 91, column 38)
        nsKNN.R (line 94, column 59)
        nsKNN.R (line 94, column 100)
        NSKNNMissingData.R (line 16, column 46)
        NSKNNMissingData.R (line 17, column 41)
        NSKNNMissingData.R (line 22, column 53)
        NSKNNMissingData.R (line 40, column 32)
        NSKNNMissingData.R (line 49, column 26)
        NSKNNMissingData.R (line 79, column 32)
        NSKNNMissingData.R (line 87, column 26)
        NSKNNMissingData.R (line 128, column 55)
        NSKNNMissingData.R (line 154, column 25)
        NSKNNMissingData.R (line 164, column 25)
        singleImputationFunctions.R (line 37, column 15)
        utils.R (line 30, column 23)
        utils.R (line 94, column 35)
        utils.R (line 129, column 23)
        utils.R (line 130, column 25)
        utils.R (line 167, column 30)
        utils.R (line 167, column 71)
Dekermanjian commented 3 years ago

@LiNk-NY Yes, but if you look at the code I have seq_along() for all of those lines. Am I doing something wrong?

bioc-issue-bot commented 3 years ago

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

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

Dekermanjian commented 3 years ago

Hi Marcel, @LiNk-NY

Here is what I have done in the latest push

DESCRIPTION

NAMESPACE

vignettes

R

Man

LiNk-NY commented 3 years ago

@LiNk-NY Yes, but if you look at the code I have seq_along() for all of those lines. Am I doing something wrong?

Hi Jonathan, @Dekermanjian

Pulling the first two examples:

  belowThreshMet = data[sortAvgIdx[seq_along(1:numMetBelowThresh)],]
  belowThreshIdx = sortAvgIdx[seq_along(1:numMetBelowThresh)]

The issue is that 1:n is still being used despite it being wrapped by seq_along. Consider this scenario where n or numMetBelowThresh is zero:

seq_along(1:0)
# [1] 1 2

and now

seq_len(0)
# integer(0)

These are not the same. The latter is more robust and the former is possibly wrong.

LiNk-NY commented 3 years ago

vignettes

  • changed name of data from data_miss to untargeted_LCMS_data
  • renamed data_miss to se for Summarized Experiment case

R

  • included vector of algorithms and match.arg
  • replaced print with message and added a verbose argument
  • added assay_ix to allow designated assay imputation by assay index
  • removed exists for stopCluster

Man

  • properly documented data_miss, added new argument documentation, and documented values returned

These are great changes! Thanks for adding them.

Best, Marcel

Dekermanjian commented 3 years ago

@LiNk-NY Okay, I understand now. I will fix all the seq_alongs ASAP.

bioc-issue-bot commented 3 years ago

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

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

Dekermanjian commented 3 years ago

Marcel, @LiNk-NY I have removed all seq_along(1:n) and replaced them with seq_len(n). Let me know if there are other changes/additions you would like me to make to MAI.

Thank you for you review of our package.

LiNk-NY commented 3 years ago

Hi Jonathan, @Dekermanjian

Thank you for making those changes and for your contribution. Your package has been accepted to Bioconductor.

Best, Marcel

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

Dekermanjian commented 3 years ago

@LiNk-NY

Thank you very much!

vjcitn commented 3 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/Dekermanjian.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("MAI"). The package 'landing page' will be created at

https://bioconductor.org/packages/MAI

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.