Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

depmap: Cancer Dependency Map data package #1096

Closed lgatto closed 5 years ago

lgatto commented 5 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 help with submitting your package, please subscribe and post questions to the bioc-devel mailing list.

bioc-issue-bot commented 5 years ago

Hi @lgatto

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: depmap
Type: Package
Title: Cancer Dependency Map Data Package
Version: 0.99.0
Author: Theo Killian, Laurent Gatto
Authors@R: c(person(given = "Laurent", family = "Gatto",
            email = "laurent.gatto@uclouvain.be",
            role = c("cre", "aut")),
         person(given = "Theo", family = "Killian",
            email = "theo.killian@gmail.com",
            role = "aut"))
Description: The depmap package is a data package that accesses datsets from the
    Broad Institute DepMap cancer dependency study using ExperimentHub. Datasets
    from the most current release are available, including RNAI and CRISPR-Cas9
    gene knockout screens quantifying the genetic dependency for select cancer
    cell lines. Additional datasets are also available pertaining to the log
    copy number of genes for select cell lines, protein expression of cell lines
    as measured by reverse phase protein lysate microarray (RPPA), 'Transcript
    Per Million' (TPM) data, as well as supplementary datasets which contain
    metadata and mutation calls for the other datasets found in the current
    release. This package will be updated on a quarterly basis to incorporate
    the latest Broad Institute DepMap Public cancer dependency datasets. All
    data made available in this package was generated by the Broad Institute
    DepMap for research purposes and not intended for clinical use. This data is
    distributed under the Creative Commons license (Attribution 4.0
    International (CC BY 4.0)).
Depends: R (>= 3.6), methods, dplyr, ExperimentHub
License: Artistic-2.0
Encoding: UTF-8
RoxygenNote: 6.1.1.9000
Suggests:
    knitr,
    rmarkdown,
    BiocStyle,
    viridis,
    gridExtra,
    ggplot2,
    readr,
    tibble,
    stringr,
    tidyr
VignetteBuilder: knitr
biocViews:
    ExperimentHub,
    ExperimentData,
    ReproducibleResearch,
    RepositoryData,
    AssayDomainData,
    CopyNumberVariationData,
    DiseaseModel,
    CancerData,
    BreastCancerData,
    ColonCancerData,
    KidneyCancerData,
    LeukemiaCancerData,
    LungCancerData,
    OvarianCancerData,
    ProstateCancerData,
    OrganismData,
    Homo_sapiens_Data,
    PackageTypeData,
    SpecimenSource,
    CellCulture,
    Genome,
    Proteome,
    StemCell,
    Tissue

Add SSH keys to your GitHub account. SSH keys will are used to control access to accepted Bioconductor packages. See these instructions to add SSH keys to your GitHub account.

bioc-issue-bot commented 5 years ago

A reviewer has been assigned to your package. Learn what to expect during the review process.

IMPORTANT: Please read the instructions for setting up a push hook on your repository, or further changes to your repository will NOT trigger a new build.

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

lgatto commented 5 years ago

I have addressed some issues with the DESCRIPTION file.

There remain two errors, one of which is a false positive. I am registered on the support site, but using my gmail address. The other error concerns manual pages without examples. The package has two executable vignettes that describe the data in good detail. Any examples in the manual pages would unnecessarily duplicate the code in the vignette.

lgatto commented 5 years ago

@nturaga - could you help me out with the apparent lack of pushes. The push webhook looks correct (this one, below, is a new one, that I just recreated now; the previous one displayed similar apparent successful deliveries)

2019-04-23-112822_746x671_scrot

2019-04-23-112723_755x871_scrot

2019-04-23-112741_758x483_scrot

I can't see any signs of pushes here, despite an bumped version number.

lshep commented 5 years ago

Could you please try another version bump so I can try and trace it on our end ? I'm having trouble finding the original because of the 5 day span (we've had a lot of activity with it being release deadline week). And please comment here when you do so I can look for it, if it isn't posting.

lgatto commented 5 years ago

Done, and now I receive the following error:

2019-04-23-215856_1168x778_scrot

So I must have done something wrong?

lshep commented 5 years ago

We are thinking it might be a capitalization issue. As the repository seems technically to be UCLouvain-CBIO/depmap while it is all lowercase in the repository link at the top of this page. Could you please update the repository link and try another version bump.

bioc-issue-bot commented 5 years ago

Received a valid push; starting a build. Commits are:

4a9f52e new version bump to trigger webhook

lgatto commented 5 years ago

Yes, that was it indeed. Sorry for the trouble.

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

lgatto commented 5 years ago

Regarding the 2 errors:

* Checking man page documentation...
    * ERROR: At least 80% of man pages documenting exported objects
      must have runnable examples. The following pages do not:
      copyNumber.Rd, crispr.Rd, depmap_release.Rd, metadata.Rd,
  mutationCalls.Rd, rnai.Rd, RPPA.Rd, TPM.Rd

There's a detailed vignette that describes these data and how to load them. Repeating the same calls in the man pages feels a bit like a waste.

* Checking for support site registration...
    * ERROR: Maintainer must register at the support site; visit
      https://support.bioconductor.org/accounts/signup/ .

I am registered on the support site, but with a different email address.

nturaga commented 5 years ago

Hi @mtmorgan, Is there a way to avoid the error on the build report "R CMD Check" without an ERROR for the maintainer being listed on the support site? @lgatto seems to be registered by since it's a different email address, it's displaying the ERROR note.

If there isn't to suppress this, is the best idea for @lgatto to use his registered gmail account in the package DESCRIPTION as well?

mtmorgan commented 5 years ago

I think the sensible thing to do is to ignore the error in the check.

bioc-issue-bot commented 5 years ago

Received a valid push; starting a build. Commits are:

0d86894 bump version to trigger bioc build

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

lgatto commented 5 years ago

There was a message asking for a version bump, which I did. The errors as still the same ones as discussed above. Let me know if there's anything you need from me.

nturaga commented 5 years ago

depmap Review

R CMD build

ok

R CMD check

ok

DESCRIPTION

ok

NAMESPACE

ok

NEWS

ok

man

ok

vignettes

ok

R

ok

Good package @lgatto !

bioc-issue-bot commented 5 years ago

Your package has been accepted. It will be added to the Bioconductor Git repository and nightly builds. Additional information will be posed to this issue in the next several days.

Thank you for contributing to Bioconductor!

lgatto commented 5 years ago

Excellent, thanks @nturaga. And thank you to @tfkillian, the co-developer.

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

https://bioconductor.org/packages/depmap

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.