Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

ATACCoGAPS #2557

Closed rossinerbe closed 2 years ago

rossinerbe commented 2 years ago

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

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: ATACCoGAPS
Title: Analysis Tools for scATACseq Data with CoGAPS
Version: 0.99.0
Authors@R: 
    person(given = "Rossin",
 family = "Erbe",
 role = c("aut", "cre"),
 comment = c(ORCID = "0000-0002-3423-2104"),
 email = "rerbe1@jhmi.edu")
Description: Provides tools for running the CoGAPS algorithm (Fertig et al, 2010) on single-cell ATAC sequencing data and analysis of the results. Can be used to perform analyses at the level of genes, motifs, TFs, or pathways. Additionally provides tools for transfer learning and data integration with single-cell RNA sequencing data.
License: Artistic-2.0
Depends:
  R (>= 3.5.0),
  CoGAPS (>= 3.5.13)
Imports:
    gtools,
    GenomicRanges,
    projectR,
    TFBSTools,
    GeneOverlap,
    msigdbr,
    tidyverse,
    gplots,
    motifmatchr,
    chromVAR,
    GenomicFeatures,
    IRanges,
    fgsea,
    rGREAT,
    JASPAR2016,
    Homo.sapiens,
    Mus.musculus
biocViews: GenomicFeatures, CoGAPS
BiocType: Software
RoxygenNote: 7.1.1
Encoding: UTF-8
Suggests: 
    knitr
VignetteBuilder: knitr
vjcitn commented 2 years ago

There is no content in the vignette. Please remedy. "Tutorial files" set should be managed in a compliant way.

rossinerbe commented 2 years ago

Thanks, I migrated the file previously labeled tutorial over to the vignette and have removed the non-compliant files.

vjcitn commented 2 years ago
--- re-building ‘ATACCoGAPS.Rmd’ using rmarkdown
Loading required package: CoGAPS
Quitting from lines 36-39 (ATACCoGAPS.Rmd) 
Error: processing vignette 'ATACCoGAPS.Rmd' failed with diagnostics:
there is no package called 'repmis'
--- failed re-building ‘ATACCoGAPS.Rmd’

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

Error: Vignette re-building failed.

Need in Suggests in DESCRIPTION?

vjcitn commented 2 years ago
[](http://127.0.0.1:12914/library/ATACCoGAPS/doc/ATACCoGAPS.html#cb1-2)[](http://127.0.0.1:12914/library/ATACCoGAPS/doc/ATACCoGAPS.html#cb1-3)[](http://127.0.0.1:12914/library/ATACCoGAPS/doc/ATACCoGAPS.html#cb1-4)[](http://127.0.0.1:12914/library/ATACCoGAPS/doc/ATACCoGAPS.html#cb1-5)[](http://127.0.0.1:12914/library/ATACCoGAPS/doc/ATACCoGAPS.html#cb1-6)[](http://127.0.0.1:12914/library/ATACCoGAPS/doc/ATACCoGAPS.html#cb1-7)[](http://127.0.0.1:12914/library/ATACCoGAPS/doc/ATACCoGAPS.html#cb1-8)[](http://127.0.0.1:12914/library/ATACCoGAPS/doc/ATACCoGAPS.html#cb2-1)#installing required Bioconductor packages
BiocManager::install(c("GenomicRanges", "projectR", "TFBSTools", "GeneOverlap", "msigdbr", "motifmatchr", "chromVAR", "GenomicFeatures", "IRanges", "fgsea", "rGREAT", "Homo.sapiens", "Mus.musculus"))

#installing latest version of CoGAPS algorithm
devtools::install_github("FertigLab/CoGAPS")

#installing ATACCoGAPS
devtools::install_github("FertigLab/ATACCoGAPS")
Attach the ATACCoGAPS package, which attaches CoGAPS as a dependency

library(ATACCoGAPS)
To outline the ATACCoGAPS pipeline, we will use as an example data set single-cell ATAC sequencing data containing 10 cell lines, published by Schep et al, 2017. The data was downloaded from GEO accession number GSE99172 and preprocessed using dataSubsetBySparsity() from the ATACCoGAPS package to remove cells and peaks with more than 99% sparsity (more than 99% zeroes). For the code used in preprocessing this data, see: https://github.com/rossinerbe/ATACCoGAPS-Analysis-Code/blob/master/Schep_data_analysis/main_analysis_peak_summarization.Rmd[](http://127.0.0.1:12914/library/ATACCoGAPS/doc/ATACCoGAPS.html#cb3-1)

repmis::source_data("https://github.com/FertigLab/ATACCoGAPS/blob/PaperVersion/data/schepFilteredData.rda?raw=true")
## Downloading data from: https://github.com/FertigLab/ATACCoGAPS/blob/PaperVersion/data/schepFilteredData.rda?raw=true
## SHA-1 hash of the downloaded data file is:
## ec9a9d3cc915ef91f52ca05727b037d3e67a6835
## [1] "schepFilteredData"

you should not be downloading data from github for your vignette. it should be in ExperimentHub. @lshep

vjcitn commented 2 years ago

also the various installation instructions do not belong in the vignette. see the guidelines for the standard advice.

rossinerbe commented 2 years ago

Okay, I refactored the vignette to use a subset of the data that's small enough to reasonably include under data/ I also used the subset to make the examples easier to run.

I removed installation instructions from the vignette as well

And I added the repmis package to Suggests

Thanks for your help!

vjcitn commented 2 years ago
ℹ Updating ATACCoGAPS documentation
Error in read_dcf(con) : Duplicate DESCRIPTION fields: 'Suggests'

please fix this. it kill devtools::document

vjcitn commented 2 years ago

Do you build/check your package on a "clean" system with no presuppositions?

PC002284:SUBMISSIONS vincentcarey$ R CMD build ATACCoGAPS
1/11 packages newly attached/loaded, see sessionInfo() for details.
* checking for file 'ATACCoGAPS/DESCRIPTION' ... OK
* preparing 'ATACCoGAPS':
* checking DESCRIPTION meta-information ... OK
* installing the package to build vignettes
* creating vignettes ... ERROR
--- re-building ‘ATACCoGAPS.Rmd’ using rmarkdown
Loading required package: CoGAPS
Quitting from lines 31-34 (ATACCoGAPS.Rmd) 
Error: processing vignette 'ATACCoGAPS.Rmd' failed with diagnostics:
object 'schepSubCellTypes' not found
--- failed re-building ‘ATACCoGAPS.Rmd’
vjcitn commented 2 years ago
PC002284:SUBMISSIONS vincentcarey$ ls ATACCoGAPS/data
schepCelltypes.rda  schepCogapsResult.rda   schepGranges.rda    schepPeaks.rda      subsetSchepData.rda

is it an orthography problem?

rossinerbe commented 2 years ago

Sorry, I did test the build so I'm not sure how that got through. I think I must have tested the build from the master branch, while the updated package was still in the update branch. Both things should be fixed now.

lshep commented 2 years ago

I am having trouble processing your package because your biocViews are invalid -- I will manually force this through but you need to update biocViews to be valid. biocViews are not package names they need to come from the list of terms http://bioconductor.org/packages/release/BiocViews.html#___Software . Make sure you have run BiocCheck on your package as well as this should have been indicated in the output of the checks.

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

lshep commented 2 years ago

You can not store data on github. that is not allowed. It must be on a trusted public server (institution, AWS S3 buckets, microsoft data lakes, zenodo, etc) or in the Bioconductor experimenthub. See Creating a Hub package

bioc-issue-bot commented 2 years ago

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

rossinerbe commented 2 years ago

okay, those two things should be fixed, along with the biocCheck errors. Thanks for your help

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/ATACCoGAPS 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: 9788c414021fb941d3bed2751870548c1abdf3c4

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/ATACCoGAPS 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: 1b92ba59c64dfada55240da7b01b990cda30fbbb

lshep commented 2 years ago

Sorry about the delay. Not sure if you were waiting for a build report. It seems it has stalled. I'm kicking off a manual build now. please address any timeout, error, or warnings

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/ATACCoGAPS 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: e4d6a0a74dbcfba3acf35d289ad2df09ddb6054a

rossinerbe commented 2 years ago

Okay, thanks. Looks like there were some problems with the examples. Those should be fixed now

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/ATACCoGAPS 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: 30f7d7dc0019cecadb0d6fc05344127f8d62aef0

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/ATACCoGAPS 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: 0b6a48a32c1728f37b56737156d11bd7fbaf9d44

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

rossinerbe commented 2 years ago

The error I'm getting is that I am not subscribed to the bioc-devel mailing list. I have tried to subscribe but it does not seem to be finding me. Do I just need to wait for it to be processed or something?

lshep commented 2 years ago

Have you checked your spam/junk folder? The confirmation email often gets labelled as spam

rossinerbe commented 2 years ago

Ah, yep, that was it. I should be subscribed now. Thanks

bioc-issue-bot commented 2 years ago

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

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

rossinerbe commented 2 years ago

Do these warnings need to be resolved?

Kayla-Morrell commented 2 years ago

@rossinerbe - I can review the package with WARNINGs but I'll most likely have them as something that needs to be addressed in your review. So up to you if you want to address them now or once I've posted the review.

bioc-issue-bot commented 2 years ago

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

rossinerbe commented 2 years ago

Okay, I fixed the warning related to docs, the others seem like they might not need to be addressed. Please let me know though

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/ATACCoGAPS 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: 4ed7181f1bdd393a14c791d9741fb3a93a340a4c

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/ATACCoGAPS 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: dc8ebf00e8fb7dd5bd4dc32922bdf00666e573d1

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

rossinerbe commented 2 years ago

@Kayla-Morrell could you do the review please and see if the warnings need to be addressed?

Kayla-Morrell commented 2 years ago

@rossinerbe - Thank you for submitting to Bioconductor. Please see the initial review of the package below. The required changes must be made while the suggested changes do not have to be (though we strongly encourage them). Comment back here with updates that have been made and when the package is ready for a re-review.

General package development

DESCRIPTION

NAMESPACE

Vignette

Man pages

Unit tests

R code

Best, Kayla

bioc-issue-bot commented 2 years ago

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

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/ATACCoGAPS 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: ecd9ff366ebb41e3dd3bf6f19464865261dc7ec2

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