Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

crisprBase #2398

Closed Jfortin1 closed 2 years ago

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

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: crisprBase
Version: 0.99.0
Date: 2021-10-25
Title: Base functions and classes for CRISPR gRNA design
Authors@R: person("Jean-Philippe", "Fortin", email = "fortin946@gmail.com", role = c("aut", "cre"))
Depends: 
    utils,
    methods,
    R (>= 4.1)
Imports:
    BiocGenerics,
    Biostrings,
    GenomicRanges,
    IRanges,
    stringr
Suggests:
    knitr,
    rmarkdown,
    testthat
biocViews: CRISPR, FunctionalGenomics
Description: Provides S4 classes for general nucleases and CRISPR nucleases.
    Several CRISPR-specific genome arithmetic functions are implemented to
    help extract genomic coordinates of spacer and protospacer sequences. 
    Commonly-used CRISPR nuclease objects are provided that can be readily
    used in other packages. 
License: MIT + file LICENSE
LazyData: TRUE
Encoding: UTF-8
RoxygenNote: 7.1.2
VignetteBuilder: knitr
Collate: 
    'AllGenerics.R'
    'Nuclease-class.R'    
    'CrisprNuclease-class.R'
    'arithmetics.R'
    'data.R'
    'utils.R'
bioc-issue-bot commented 2 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 2 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: "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. 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/crisprBase to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

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

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

Jfortin1 commented 2 years ago

@LiNk-NY Hi Marcel, thanks for reviewing this package. The only error now for the package comes from the fact that testthat does not build on CRAN at the moment.

LiNk-NY commented 2 years ago

Hi Jean-Philippe, @Jfortin1

It looks like testthat should be available on Mac now. Please bump the version for another build. I will review your package today.

Best, Marcel

LiNk-NY commented 2 years ago

Hi Jean-Philippe, @Jfortin1 Thank you for your submission. Please see the review below. Best regards, Marcel


crisprBase #2398

DESCRIPTION

NAMESPACE

vignettes

R

tests

bioc-issue-bot commented 2 years ago

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

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

Jfortin1 commented 2 years ago

Thanks @LiNk-NY for your review -- I've improved the package to incorporate your comments and suggestions. The only exception is leaving LazyData=TRUE as

LiNk-NY commented 2 years ago

Hi Jean-Philippe, @Jfortin1 This is not a good argument for using LazyData. I can see the convenience but for readability's sake, it is best to use data("SpCas9", package = "crisprBase") instead. This makes the user immediately aware of what is being requested and from where. Please remember to respond to the review line-by-line. Thank you.

bioc-issue-bot commented 2 years ago

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

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

bioc-issue-bot commented 2 years ago

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

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

Jfortin1 commented 2 years ago

@LiNk-NY Hi Marcel, I have now modified the package to use LazyData=False, and please find below my line-by-line review. The package has now an ERROR because of the DESCRIPTION file being malformed, supposedly. I cannot recapitulate this error locally with BiocCheck 1.31.14. Any idea what could be going on?

DESCRIPTION

NAMESPACE

Vignette

R

bioc-issue-bot commented 2 years ago

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

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

LiNk-NY commented 2 years ago

Hi Jean-Philippe, @Jfortin1

Thank you for making those changes. They look good. Please use dedicated getter functions and avoid using the @ operator in the CrisprNuclease show method.

The metadata generic is defined in S4Vectors and you can use it to create a method for your class.

Best regards, Marcel

bioc-issue-bot commented 2 years ago

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

Jfortin1 commented 2 years ago

Hi Marcel @LiNk-NY,

We have now changed the show method for both CrisprNuclease and Nuclease to only use getter functions. We were already importing metadata from S4Vectors, so we used that. Thanks!

Waiting for the build to finish now.

Best, JP

LiNk-NY commented 2 years ago

Hi Jean-Phlippe, @Jfortin1

Sorry for the mix up. The appropriate way to get the metadata functionality is by adding

contains = "Annotated"

to the class definition.

This will grant you a metadata method via inheritance so you won't need to define the method.

Best, Marcel

bioc-issue-bot commented 2 years ago

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

Jfortin1 commented 2 years ago

Hi Marcel @LiNk-NY, that's a great suggestion, thank you. I have now changed the Nuclease object to extend the Annotated class, and reused the metadata method via inheritance. Documentation and vignette are updated as well.

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

LiNk-NY commented 2 years ago

Thanks!

Jfortin1 commented 2 years ago

Thank you for all of your time and feedback, much appreciated!

Jfortin1 commented 2 years ago

@LiNk-NY Hi Marcel, It seems the package is not yet building in BioC 3.15 -- is there anything else I should do from my side?

lshep commented 2 years ago

@Jfortin1 nothing else to do from your sorry. I needed to process the accepted packages. I will do that now and it should appear available within the next 48 hours as long as it still install/builds/checks cleanly on the daily builder. Sorry for the delay

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

https://bioconductor.org/packages/crisprBase

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.