Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

Submission of ProteinGymR #3575

Closed tram-nguyen-n closed 3 weeks ago

tram-nguyen-n commented 1 month 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 month ago

Hi @tram-nguyen-n

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: ProteinGymR
Title: Programmatic access to ProteinGym datasets in R/Bioconductor
Version: 0.99.0
Authors@R: 
    c(person("Tram", "Nguyen",
  role = c("aut", "cre"),
  email = "Tram_Nguyen@hms.harvard.edu",
  comment = c(ORCID = "0000-0003-4809-6227")),
      person("Pascal", "Notin", 
  role = "aut"),
      person("Aaron", "Kollasch", 
  role = "aut"),
      person("Ludwig", "Geistlinger", 
  role = "aut"))
Description: The ProteinGymR package provides analysis-ready data resources from 
    ProteinGym, generated by Notin et al., 2023. ProteinGym comprises a 
    collection of benchmarks for evaluating the performance of models 
    predicting the effect of point mutations. This package provides access to 
    1. Deep mutational scanning (DMS) scores from 216 assays measuring the 
    impact of all possible amino acid substitutions across 186 proteins, 2. 
    AlphaMissense pathogenicity scores for ~1.6 M substitutions in the 
    ProteinGym DMS data, and 3. five performance metrics for 62 variant 
    prediction models in a zero-shot setting.
License: Artistic-2.0
URL: https://github.com/ccb-hms/ProteinGymR
BugReports: https://github.com/ccb-hms/ProteinGymR/issues
Depends:
    R (>= 4.4.1)
Imports: 
    AnnotationHub,
    ExperimentHub,
    dplyr,
    forcats,
    ggdist,
    gghalves,
    ggplot2,
    purrr,
    queryup,
    spdl,
    tidyr,
    tibble
Suggests: 
    BiocStyle,
    knitr,
    testthat (>= 3.0.0)
VignetteBuilder: 
    knitr
Encoding: UTF-8
biocViews: ExperimentData, ExperimentHub, PackageTypeData, Homo_sapiens_Data,
    ReproducibleResearch, CellCulture, SequencingData
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.2
Config/testthat/edition: 3
bioc-issue-bot commented 1 month 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 month 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: "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.

The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 24.04.1 LTS): ProteinGymR_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/ProteinGymR 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 month ago

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

bioc-issue-bot commented 1 month 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: "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.

The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 24.04.1 LTS): ProteinGymR_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/ProteinGymR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

lshep commented 1 month ago

ignore support site ERROR for now.

bioc-issue-bot commented 1 month ago

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

bioc-issue-bot commented 1 month 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: ERROR before build products produced.

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/ProteinGymR 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 month ago

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

tram-nguyen-n commented 4 weeks ago

Hi Bioconductor Team, with the upcoming release schedule I wanted to check on the status of this review and see when we might expect to hear back. Please let me know if I can provide anything else to help the process. Thanks!

hpages commented 4 weeks ago

Thanks @tram-nguyen-n for this submission.

R CMD check fails for me (see below). Can you take a look? Also please try to address the NOTEs (2 of them, the 1st and 3rd, should be straightforward to get rid of).

Thanks, H.

@lshep The last SPB report is empty but the bioc-issue-bot still reports that "The package built without errors or warnings on all platforms". Any idea what could have caused something like this?

hpages@XPS15:~$ time R CMD check ProteinGymR_0.99.2.tar.gz 
* using log directory ‘/home/hpages/pkgreviews/ProteinGymR.expressreview/ProteinGymR.Rcheck’
* using R version 4.4.0 (2024-04-24)
* using platform: x86_64-pc-linux-gnu
* R was compiled by
    gcc (Ubuntu 13.2.0-4ubuntu3) 13.2.0
    GNU Fortran (Ubuntu 13.2.0-4ubuntu3) 13.2.0
* running under: Ubuntu 23.10
* using session charset: UTF-8
* checking for file ‘ProteinGymR/DESCRIPTION’ ... OK
* this is package ‘ProteinGymR’ version ‘0.99.2’
* package encoding: UTF-8
* checking package namespace information ... OK
* checking package dependencies ... OK
* checking if this is a source package ... OK
* checking if there is a namespace ... OK
* checking for hidden files and directories ... OK
* checking for portable file names ... OK
* checking for sufficient/correct file permissions ... OK
* checking whether package ‘ProteinGymR’ can be installed ... OK
* checking installed package size ... OK
* checking package directory ... OK
* checking ‘build’ directory ... OK
* checking DESCRIPTION meta-information ... OK
* checking top-level files ... OK
* checking for left-over files ... OK
* checking index information ... OK
* checking package subdirectories ... OK
* checking code files for non-ASCII characters ... OK
* checking R files for syntax errors ... OK
* checking whether the package can be loaded ... OK
* checking whether the package can be loaded with stated dependencies ... OK
* checking whether the package can be unloaded cleanly ... OK
* checking whether the namespace can be loaded with stated dependencies ... OK
* checking whether the namespace can be unloaded cleanly ... OK
* checking loading without being on the library search path ... OK
* checking dependencies in R code ... NOTE
Namespaces in Imports field not imported from:
  ‘AnnotationHub’ ‘tibble’
  All declared Imports should be used.
* checking S3 generic/method consistency ... OK
* checking replacement functions ... OK
* checking foreign function calls ... OK
* checking R code for possible problems ... NOTE
benchmark_models: no visible global function definition for ‘all_of’
benchmark_models: no visible global function definition for
  ‘everything’
benchmark_models: no visible binding for global variable ‘model’
benchmark_models: no visible binding for global variable ‘score’
benchmark_models: no visible binding for global variable ‘model_mean’
dms_corr_plot: no visible binding for global variable ‘uID’
dms_corr_plot: no visible binding for global variable ‘.data’
pg_correlate: no visible global function definition for ‘cor.test’
pg_filter_am_table: no visible binding for global variable ‘Entry Name’
pg_filter_am_table: no visible binding for global variable ‘.data’
pg_match_id: no visible global function definition for ‘na.omit’
pg_match_id: no visible binding for global variable ‘UniProt_id’
pg_match_id: no visible binding for global variable ‘mutant’
pg_match_id: no visible binding for global variable ‘AlphaMissense’
pg_match_id: no visible binding for global variable ‘DMS_score’
Undefined global functions or variables:
  .data AlphaMissense DMS_score Entry Name UniProt_id all_of cor.test
  everything model model_mean mutant na.omit score uID
Consider adding
  importFrom("stats", "cor.test", "na.omit")
to your NAMESPACE file.
* checking Rd files ... OK
* checking Rd metadata ... OK
* checking Rd cross-references ... OK
* checking for missing documentation entries ... OK
* checking for code/documentation mismatches ... OK
* checking Rd \usage sections ... OK
* checking Rd contents ... OK
* checking for unstated dependencies in examples ... OK
* checking installed files from ‘inst/doc’ ... OK
* checking files in ‘vignettes’ ... OK
* checking examples ... ERROR
Running examples in ‘ProteinGymR-Ex.R’ failed
The error most likely occurred in:

> ### Name: dms_corr_plot
> ### Title: Integrate ProteinGym DMS and AlphaMissense Pathogenicity Scores
> ### Aliases: dms_corr_plot
> 
> ### ** Examples
> 
> 
> dms_corr_plot(uniprotId = "Q9NV35")
'alphamissense_table' not provided, using default table from `ProteinGymR::am_scores()`
see ?ProteinGymR and browseVignettes('ProteinGymR') for documentation
loading from cache
'dms_table' not provided, using default table from `ProteinGymR::dms_substitutions()`
see ?ProteinGymR and browseVignettes('ProteinGymR') for documentation
loading from cache
Error in `purrr::keep()`:
ℹ In index: 16.
ℹ With name: ANCSZ_Hobbs_2022.
Caused by error:
! `.p()` must return a single `TRUE` or `FALSE`, not `NA`.
Backtrace:
     ▆
  1. └─ProteinGymR::dms_corr_plot(uniprotId = "Q9NV35")
  2.   └─ProteinGymR:::pg_filter_dms_table(pg_table = dms_table, uID = uniprotId)
  3.     └─purrr::keep(pg_table, ~any(.x$UniProt_id == uID))
  4.       └─purrr:::where_if(.x, .p, ...)
  5.         └─purrr:::map_(.x, .p, ..., .type = "logical", .purrr_error_call = .purrr_error_call)
  6.           ├─purrr:::with_indexed_errors(...)
  7.           │ └─base::withCallingHandlers(...)
  8.           ├─purrr:::call_with_cleanup(...)
  9.           └─purrr (local) .f(.x[[i]], ...)
 10.             └─cli::cli_abort(...)
 11.               └─rlang::abort(...)
Execution halted
* checking for unstated dependencies in ‘tests’ ... OK
* checking tests ...
  Running ‘testthat.R’
 OK
* checking for unstated dependencies in vignettes ... NOTE
'::' or ':::' import not declared from: ‘ComplexHeatmap’
'library' or 'require' calls not declared from:
  ‘ComplexHeatmap’ ‘stringr’
* checking package vignettes ... OK
* checking re-building of vignette outputs ... ERROR
Error(s) in re-building vignettes:
  ...
--- re-building ‘data_import_and_representation.Rmd’ using rmarkdown

Quitting from lines 55-61 [unnamed-chunk-2] (data_import_and_representation.Rmd)
Error: processing vignette 'data_import_and_representation.Rmd' failed with diagnostics:
there is no package called 'ComplexHeatmap'
--- failed re-building ‘data_import_and_representation.Rmd’

SUMMARY: processing the following file failed:
  ‘data_import_and_representation.Rmd’

Error: Vignette re-building failed.
Execution halted

* checking PDF version of manual ... OK
* DONE

Status: 2 ERRORs, 3 NOTEs
See
  ‘/home/hpages/pkgreviews/ProteinGymR.expressreview/ProteinGymR.Rcheck/00check.log’
for details.

real    1m32.465s
user    1m10.535s
sys 0m3.995s
bioc-issue-bot commented 3 weeks ago

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

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

The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 24.04.1 LTS): ProteinGymR_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/ProteinGymR 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 weeks ago

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

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

The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 24.04.1 LTS): ProteinGymR_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/ProteinGymR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

tram-nguyen-n commented 3 weeks ago

Thanks @hpages, it should be fixed now. The only error I see now is for the Watched Tags which @lshep and I are working through. Please let me know if I missed something.

hpages commented 3 weeks ago

Thanks @tram-nguyen-n

Package looks good and will be ready to go after you address the following R CMD check WARNING and NOTE (see Single Package Builder report above):

* checking DESCRIPTION meta-information ... WARNING
Dependence on R version 4.4.1 not with patchlevel 0
* checking dependencies in R code ... NOTE
Namespaces in Imports field not imported from:
  AnnotationHub tibble
  All declared Imports should be used.

Thanks again, H.

bioc-issue-bot commented 3 weeks ago

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

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

The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 24.04.1 LTS): ProteinGymR_0.99.5.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/ProteinGymR 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 weeks ago

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

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

The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 24.04.1 LTS): ProteinGymR_0.99.6.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/ProteinGymR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

tram-nguyen-n commented 3 weeks ago

I think that should do it. Thanks again @hpages!

hpages commented 3 weeks ago

Thanks!

bioc-issue-bot commented 3 weeks 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 3 weeks 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/tram-nguyen-n.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("ProteinGymR"). The package 'landing page' will be created at

https://bioconductor.org/packages/ProteinGymR

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.