Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

crisprDesign #2647

Closed Jfortin1 closed 2 years ago

Jfortin1 commented 2 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 2 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: crisprDesign
Title: Comprehensive design of CRISPR gRNAs for nucleases and base editors
Version: 0.99.77
Authors@R: c(
    person("Jean-Philippe", "Fortin", email = "fortin946@gmail.com", role = c("aut", "cre")),
    person("Luke", "Hoberecht", email = "lukehob3@gmail.com", role = c("aut"))
    )
Description: 
    Provides a comprehensive suite of functions to design and annotate CRISPR guide RNA (gRNAs) sequences. This 
    includes on- and off-target search, on-target efficiency scoring, off-target scoring, full gene and TSS
    contextual annotations, and SNP annotation (human only). It currently support five types of CRISPR 
    modalities (modes of perturbations): CRISPR knockout, CRISPR activation, CRISPR inhibition, 
    CRISPR base editing, and CRISPR knockdown. All types of CRISPR nucleases are supported, including
    DNA- and RNA-target nucleases such as Cas9, Cas12a, and Cas13d. All types of base editors are
    also supported. gRNA design can be performed on reference genomes, transcriptomes,
    and custom DNA and RNA sequences. 
Depends: R (>= 4.2.0),
    crisprBase (>= 0.99.15)
Imports:
    AnnotationDbi,
    BiocGenerics,
    Biostrings,
    BSgenome,
    crisprBowtie (>= 0.99.8),
    crisprScore (>= 0.99.24),
    GenomeInfoDb,
    GenomicFeatures,
    GenomicRanges (>= 1.38.0),
    IRanges,
    Matrix,
    MatrixGenerics,
    methods,
    S4Vectors,
    stats,
    utils,
    VariantAnnotation
Suggests:
    biomaRt,
    BSgenome.Hsapiens.UCSC.hg38,
    BSgenome.Mmusculus.UCSC.mm10,
    BiocStyle,
    crisprBwa (>= 0.99.7),
    knitr,
    rmarkdown,
    Rbowtie,
    Rbwa,
    RCurl,
    testthat
biocViews:
    CRISPR,
    FunctionalGenomics,
    GeneTarget
License: MIT + file LICENSE
Encoding: UTF-8
RoxygenNote: 7.1.2
VignetteBuilder: knitr
BugReports: https://github.com/Jfortin1/crisprDesign/issues
URL: https://github.com/Jfortin1/crisprDesign
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: "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/crisprDesign 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: e836d1c063f5f076e12946a001c810f6f22a8996

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/crisprDesign 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: ddc7277ceb65422f829bab2f7a1da7d452a3ba14

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/crisprDesign 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

@nturaga Thanks for reviewing one more of our CRISPR packages! Is there anything I should do from my side before you review the package?

nturaga commented 2 years ago

@Jfortin1 Just getting back into package reviews after the post-release work/conferences. Will get to it in the next week!

One thing you can do is fix the warning messages on build report before I have a look at it.

bioc-issue-bot commented 2 years ago

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

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: "skipped, WARNINGS, 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/crisprDesign 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: 56b7da07c773e1f5955c76ee434c19f4a0d5bc89

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: "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/crisprDesign 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: 9bcb4635707ff9054b9adf0b9b101e8307312a5a

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, 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/crisprDesign 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: 28ad56f18ebfb16cafa9a98c161f66b25ade2be7

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, 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/crisprDesign 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: bea287ede55edf49d3d3543aba19d0852d0eca22

bioc-issue-bot commented 2 years ago

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

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: "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/crisprDesign 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: df73c83eb0a506cecc50ee2e94145e9f7a5a1487

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/crisprDesign 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: 18399b976c9d74fb763006de96376d32579a0145

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

nturaga commented 2 years ago

Hi @Jfortin1 , hope things are going well.

Review

DESCRIPTION

NAMESPACE

NEWS

R

inst

man

ok

tests

vignettes

bioc-issue-bot commented 2 years ago

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

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/crisprDesign 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 @nturaga for your review! I've made the changes and the new push builds successfully.

Here are my answers to your review:

DESCRIPTION

ok

NAMESPACE

ok

NEWS

ok

R

Well-written code! Some of the private functions could use a little more documentation (consider this for a future time).

JP: I agree; I went over all the R files and added comments on top of the private functions.

Remove some of the commented-out code.

JP: done.

The package is very extensive and took a long time to review. There seems to be a new error on the build report (6 days ago) caused by a namespace issue. Please investigate and fix it.

JP: fixed now.

inst

ok

man

ok

tests

Very good!

JP: thanks!

vignettes

Good vignette.

JP: thanks!

Is there a reason you have a more_vignettes folder in the inst/ directory? You can just put additional vignettes in the vignettes/ dir.

JP: deprecated now, I've removed it.

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.

Jfortin1 commented 2 years ago

@nturaga Hi Nitesh, the package is still not in the nightly build -- any chance we could add it in the next couple of days? Thanks!

lshep commented 2 years ago

I have been away on holiday and will be processing all the accepted packages on Monday. You can expect it in the daily builder on Tuesday

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

https://bioconductor.org/packages/crisprDesign

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.

Jfortin1 commented 2 years ago

@lshep Thank you!