Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

regionalpcs #3131

Closed tyeulalio closed 1 year ago

tyeulalio 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 @tyeulalio

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: regionalpcs
Title: Summarizing Regional Methylation with Regional Principal Components Analysis
Version: 0.99.1
Authors@R: 
    person("Tiffany", "Eulalio", , "tyeulalio@gmail.com", 
 role = c("aut", "cre"), 
 comment = c(ORCID = "0000-0002-7084-9646"))
Description: 
    Functions to summarize DNA methylation data using regional principal
    components. Regional principal components are computed using principal 
    components analysis within genomic regions to summarize the variability 
    in methylation levels across CpGs. The number of principal components is
    chosen using either the Marcenko-Pasteur or Gavish-Donoho method to
    identify relevant signal in the data.
License: MIT + file LICENSE
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
URL: https://github.com/tyeulalio/regionalpcs
BugReports: https://github.com/tyeulalio/regionalpcs/issues
biocViews: 
    DNAMethylation, 
    DifferentialMethylation, 
    StatisticalMethod, 
    Software, 
    MethylationArray
Imports: 
    dplyr, 
    magrittr, 
    PCAtools, 
    tibble
Suggests: 
    GenomicRanges, 
    IlluminaHumanMethylation450kanno.ilmn12.hg19, 
    knitr, 
    liftOver, 
    rmarkdown, 
    RMTstat,
    RNOmni,
    testthat (>= 3.0.0), 
    tidyverse,
    BiocStyle
Config/testthat/edition: 3
VignetteBuilder: knitr
Depends: 
    R (>= 4.3.0)
LazyData: false
bioc-issue-bot commented 1 year 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 1 year ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on the Bioconductor Build System.

On one or more platforms, the build results were: "ERROR, skipped". 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 Bioconductor Build System: macOS 12.6.5 Monterey: regionalpcs_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/regionalpcs 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: 738e9f00209f394e557526137ac547d351d3b377

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 the Bioconductor Build System.

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 Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): regionalpcs_0.99.2.tar.gz macOS 12.6.5 Monterey: regionalpcs_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/regionalpcs 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

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

LiNk-NY commented 1 year ago

Hi Tiffany, @tyeulalio Thank you for your submission. Please see the review below. Best, Marcel


regionalpcs

DESCRIPTION

NAMESPACE

vignettes

R

bioc-issue-bot commented 1 year ago

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

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 the Bioconductor Build System.

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 Bioconductor Build System: macOS 12.6.5 Monterey: regionalpcs_0.99.3.tar.gz Linux (Ubuntu 22.04.2 LTS): regionalpcs_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/regionalpcs to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

tyeulalio commented 1 year ago

Hello Marcel, @LiNk-NY Thank you for the helpful review. I have incorporated your feedback into the newest package update. I've responded to each comment below with the changes that were implemented. Best, Tiffany

regionalpcs

  • The package looks sound. It should use Bioconductor functionality such as TxDb.* and GenomicFeatures. You can also download methylation data from a number of packages that provide it (e.g., curatedTCGAData (disclaimer: my package), GenomicDataCommons, RTCGA.methylation, TCGAbiolinks, etc.)

Thanks for the suggestion, I wasn't familiar with many of these packages. I removed all of the data that I had included with my package. I opted for TxDb+minfi to get the genomic annotations and a small example methylation dataset for the vignette.

DESCRIPTION

  • Looks good

NAMESPACE

  • Minimal number of exports, good.
  • Avoid using magrittr pipe %>% and use the native pipe |>.

I replaced all pipes with the native pipe throughout the entire package.

vignettes

  • Add author: in yaml header
  • First part of the vignette seems to be closer to a workflow. Can it be reduced just to highlight the package functionality?

Added author to yaml header as requested. I cut out the beginning of the vignette and went straight from loading the data to using the package.

R

  • Use match.arg in compute_regional_pcs (and others) and use c("gd", "mp") as the default pc_method argument.
  • Use Bioconductor infrastructure instead of providing your own data. There are packages that allow you to download promoter regions and methylation data and possibly avoid using liftOver.

Thanks, match.arg is quite useful! I used this in all functions where appropriate. As mentioned above, I removed all data that was included with the package and used Bioconductor packages instead. No longer using liftOver in the package.

LiNk-NY commented 1 year ago

Hi Tiffany, @tyeulalio I'm glad to hear that you were able to re-use existing datasets! The package looks good.

Best, Marcel

PS. Note that you can use switch to obtain the appropriate function if both function calls have the same signature:

compute_dimension <- function(x, var_explained, noise_select, method = c("gd", "mp"), verbose = FALSE) {
  method <- match.arg(method)
  FUN <- switch(
    method, 
    gd = PCAtools::chooseGavishDonoho,
    mp = PCAtools::chooseMarchenkoPastur
  )
  FUN(var.explained = var_explained, nose = noise_select)
}
bioc-issue-bot commented 1 year ago

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

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 the Bioconductor Build System.

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 Bioconductor Build System: macOS 12.6.5 Monterey: regionalpcs_0.99.4.tar.gz Linux (Ubuntu 22.04.2 LTS): regionalpcs_0.99.4.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/regionalpcs to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

tyeulalio commented 1 year ago

Hi Marcel, @LiNk-NY

Thanks for the tip! I updated the compute_dimension function using the switch statement.

Best, Tiffany

LiNk-NY commented 1 year ago

Thanks for making those changes. Your package has been accepted. Best, Marcel

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.

tyeulalio commented 1 year ago

Thank you Marcel! @LiNk-NY That's great news! I appreciate all of your time and help with my package. Best, Tiffany

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

https://bioconductor.org/packages/regionalpcs

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.