Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AlphaMissenseR #3221

Closed
10 tasks done
mtmorgan opened this issue Oct 18, 2023 · 27 comments
Closed
10 tasks done

AlphaMissenseR #3221

mtmorgan opened this issue Oct 18, 2023 · 27 comments
Assignees
Labels
3a. accepted will be ingested into Bioconductor daily builder for distribution OK

Comments

@mtmorgan
Copy link
Contributor

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 understand that by submitting my package to Bioconductor,
    the package source and all review commentary are visible to the
    general public.

  • I have read the Bioconductor Package Submission
    instructions. My package is consistent with the Bioconductor
    Package Guidelines.

  • I understand Bioconductor Package Naming Policy and acknowledge
    Bioconductor may retain use of package name.

  • I understand that a minimum requirement for package acceptance
    is to pass R CMD check and R CMD BiocCheck with no ERROR or WARNINGS.
    Passing these checks does not result in automatic acceptance. The
    package will then undergo a formal review and recommendations for
    acceptance regarding other Bioconductor standards will be addressed.

  • My package addresses statistical or bioinformatic issues related
    to the analysis and comprehension of high throughput genomic data.

  • I am committed to the long-term maintenance of my package. This
    includes monitoring the support site for issues that users may
    have, subscribing to the bioc-devel mailing list to stay aware
    of developments in the Bioconductor community, responding promptly
    to requests for updates from the Core team in response to changes in
    R or underlying software.

  • I am familiar with the Bioconductor code of conduct and
    agree to abide by it.

I am familiar with the essential aspects of Bioconductor software
management, including:

  • The 'devel' branch for new packages and features.
  • The stable 'release' branch, made available every six
    months, for bug fixes.
  • Bioconductor version control using Git
    (optionally via GitHub).

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
Copy link
Collaborator

Hi @mtmorgan

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: AlphaMissenseR
Title: Accessing AlphaMissense Data Resources in R
Version: 0.99.6
Authors@R: 
    c(person(
        "Martin", "Morgan", role = c("aut", "cre"),
        email = "mtmorgan.bioc@gmail.com",
        comment = c(ORCID = "0000-0002-5874-8148")
    ), person(
        "Chan Zuckerberg Initiative DAF CZF2019-002443",
        role = "fnd"
    ), person(
        "NIH NCI ITCR U24CA180996",
        role = "fnd"
    ))
Description:
    The AlphaMissense publication
    <https://www.science.org/doi/epdf/10.1126/science.adg7492>
    outlines how a variant of AlphaFold / DeepMind was used to predict
    missense variant pathogenicity. Supporting data on Zenodo
    <https://zenodo.org/record/8360242> include, for instance, 71M
    variants across hg19 and hg38 genome builds. The 'AlphaMissense'
    package allows ready access to the data, downloading individual
    files to DuckDB databases for exploration and integration into *R*
    and *Bioconductor* workflows.
License: Artistic-2.0
URL: https://mtmorgan.github.io/AlphaMissenseR/
BugReports: https://github.com/mtmorgan/AlphaMissenseR/issues
Depends:
    dplyr
Imports:
    rjsoncons, jsonlite, DBI, duckdb (>= 0.9.1), rlang,
    curl, BiocFileCache, spdl, memoise, utils,
    whisker
Suggests:
    BiocManager,
    BiocGenerics,
    GenomicRanges,
    GenomeInfoDb,
    AnnotationHub,
    ensembldb,
    methods,
    tidyr,
    knitr,
    rmarkdown,
    testthat (>= 3.0.0)
biocViews: SNP, Annotation, FunctionalGenomics, StructuralPrediction,
    Transcriptomics, VariantAnnotation
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
VignetteBuilder: knitr
Config/testthat/edition: 3

@bioc-issue-bot bioc-issue-bot added the 1. awaiting moderation submitted and waiting clearance to access resources label Oct 18, 2023
@lshep lshep added the pre-check passed pre-review performed and ready to be added to git label Nov 1, 2023
@bioc-issue-bot
Copy link
Collaborator

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 bioc-issue-bot added pre-review on bioconductor git and access to on demand build but not assigned reviewer until build report clean and removed 1. awaiting moderation submitted and waiting clearance to access resources pre-check passed pre-review performed and ready to be added to git labels Nov 1, 2023
@bioc-issue-bot
Copy link
Collaborator

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:
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/AlphaMissenseR to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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".
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: AlphaMissenseR_0.99.7.tar.gz
Linux (Ubuntu 22.04.2 LTS): AlphaMissenseR_0.99.7.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/AlphaMissenseR to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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".
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: AlphaMissenseR_0.99.8.tar.gz
Linux (Ubuntu 22.04.2 LTS): AlphaMissenseR_0.99.8.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/AlphaMissenseR to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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: AlphaMissenseR_0.99.9.tar.gz
Linux (Ubuntu 22.04.2 LTS): AlphaMissenseR_0.99.9.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/AlphaMissenseR to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@bioc-issue-bot bioc-issue-bot added OK and removed ERROR labels Nov 2, 2023
@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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: "TIMEOUT, 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:
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/AlphaMissenseR to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@bioc-issue-bot bioc-issue-bot added TIMEOUT and removed OK labels Nov 3, 2023
@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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: AlphaMissenseR_0.99.12.tar.gz
Linux (Ubuntu 22.04.2 LTS): AlphaMissenseR_0.99.12.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/AlphaMissenseR to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@bioc-issue-bot bioc-issue-bot added OK and removed TIMEOUT labels Nov 4, 2023
@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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:
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/AlphaMissenseR to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@bioc-issue-bot bioc-issue-bot added ERROR and removed OK labels Nov 4, 2023
@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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): AlphaMissenseR_0.99.14.tar.gz
macOS 12.6.5 Monterey: AlphaMissenseR_0.99.14.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/AlphaMissenseR to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@bioc-issue-bot bioc-issue-bot added OK and removed ERROR labels Nov 5, 2023
@vjcitn vjcitn added the 2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place label Nov 8, 2023
@bioc-issue-bot
Copy link
Collaborator

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 bioc-issue-bot removed the pre-review on bioconductor git and access to on demand build but not assigned reviewer until build report clean label Nov 8, 2023
@LiNk-NY
Copy link

LiNk-NY commented Nov 9, 2023

Hi Martin, @mtmorgan

Thank you for your submission.
Please see the review below.

Best regards,
Marcel


AlphaMissenseR #3221

DESCRIPTION && NAMESPACE

  • Looks good.

vignettes

  • Should sql_template be exported or should the template be copied and
    pasted into the vignette? It is good to avoid using ::: in the vignette.
  • Would it make sense to provide a clear_cache wrapper function for
    removing resources that can be identified as incompatible with newer versions
    of DuckDb? It may not be necessary if new users of the package are
    already on newer versions of DuckDb.
  • Minor: It would be good to have the file size info shown when downloading.

R

  • Consider using BiocBaseUtils for type checking of arguments.
  • Looks good.

tests

Consider increasing coverage for some files. Overall, they look good.

> covr::package_coverage()
AlphaMissenseR Coverage: 44.08%
R/AlphaFold.R: 0.00%
R/alphamissense_connection.R: 0.00%
R/am_aa.R: 0.00%
R/zzz.R: 0.00%
R/AlphaMissense.R: 57.69%
R/GenomicRanges.R: 72.22%
R/template.R: 85.71%
R/db.R: 91.58%
R/utilities.R: 91.67%

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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): AlphaMissenseR_0.99.15.tar.gz
macOS 12.6.5 Monterey: AlphaMissenseR_0.99.15.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/AlphaMissenseR to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@mtmorgan
Copy link
Contributor Author

mtmorgan commented Nov 10, 2023

Thanks Marcel @LiNk-NY

vignettes

  • Should sql_template be exported or should the template be copied and
    pasted into the vignette? It is good to avoid using ::: in the vignette.

I include the template directly

  • Would it make sense to provide a clear_cache wrapper function for
    removing resources that can be identified as incompatible with newer versions
    of DuckDb? It may not be necessary if new users of the package are
    already on newer versions of DuckDb.

This is really an exceptional situation for very early adopters. The package requires a current version of DuckDB, so it will not create 'old' tables. There's a chance that the finalized DuckDb will change formats (there's only one release left for finalization, according to their plan...) but it's not known what changes will be required then.

  • Minor: It would be good to have the file size info shown when downloading.

Done, e.g.,

* [21:56:17][info] retrieving file name 'AlphaMissense_hg38.tsv.gz' (613.2 Mb)

R

  • Consider using BiocBaseUtils for type checking of arguments.

Done

tests

Consider increasing coverage for some files. Overall, they look good.

> covr::package_coverage()
AlphaMissenseR Coverage: 44.08%
R/AlphaFold.R: 0.00%
R/alphamissense_connection.R: 0.00%
R/am_aa.R: 0.00%
R/zzz.R: 0.00%
R/AlphaMissense.R: 57.69%
R/GenomicRanges.R: 72.22%
R/template.R: 85.71%
R/db.R: 91.58%
R/utilities.R: 91.67%

I increased test coverage, thanks. Currently

> covr::package_coverage()
AlphaMissenseR Coverage: 65.43%
R/zzz.R: 0.00%
R/AlphaFold.R: 29.73%
R/AlphaMissense.R: 55.56%
R/GenomicRanges.R: 72.22%
R/db.R: 92.63%
R/alphamissense_connection.R: 100.00%
R/am_aa.R: 100.00%
R/template.R: 100.00%
R/utilities.R: 100.00%

R/zzz.R is .onLoad(), so difficult to test directly, but test-zzz.R does make sure that all side effects of .onLoad() are realized (e.g., 'memoizing' key functions).

R/AlphaFold.R is somehow suspect -- there was 30% coverage before I added another test that I expected to result in much higher coverage, but covr reported a decrease...

Examples and vignettes cover more of the package.

Please let me know if there are more changes you would like made.

@LiNk-NY
Copy link

LiNk-NY commented Dec 1, 2023

Hi Martin, @mtmorgan
Thank you for making those changes.

Coverage looks great:

> covr::package_coverage(type="all")


AlphaMissenseR Coverage: 87.01%
R/zzz.R: 0.00%
R/AlphaMissense.R: 72.22%
R/GenomicRanges.R: 72.22%
R/db.R: 92.63%
R/AlphaFold.R: 97.30%
R/alphamissense_connection.R: 100.00%
R/am_aa.R: 100.00%
R/template.R: 100.00%
R/utilities.R: 100.00%

Your package has been accepted.
Thank you for your contributions!

Best,
Marcel

@LiNk-NY LiNk-NY added 3a. accepted will be ingested into Bioconductor daily builder for distribution and removed 2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place labels Dec 1, 2023
@bioc-issue-bot
Copy link
Collaborator

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.

@mtmorgan
Copy link
Contributor Author

mtmorgan commented Dec 1, 2023

Thanks Marcel for your review and help with this package.

@bioc-issue-bot
Copy link
Collaborator

cannot build unless issue is open and has the
'pre-review' label or '2. review in progress' label,
or is closed and has the 'TESTING' label.

@lshep
Copy link
Contributor

lshep commented Dec 5, 2023

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

https://bioconductor.org/packages/AlphaMissenseR

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.

@lshep lshep closed this as completed Dec 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3a. accepted will be ingested into Bioconductor daily builder for distribution OK
Projects
None yet
Development

No branches or pull requests

5 participants