Bioconductor / Contributions

Contribute Packages to Bioconductor
131 stars 33 forks source link

chevreul #3332

Open whtns opened 3 months ago

whtns commented 3 months 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 months ago

Hi @whtns

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:

Type: Package
Package: chevreul
Title: Tools for managing SingleCellExperiment objects as projects
Version: 0.99.0
Authors@R: c(
    person("Kevin", "Stachelek", , "kevin.stachelek@gmail.com", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-2085-695X")),
    person("Bhavana", "Bhat", , "bhavanabhat29@gmail.com", role = "aut")
  )
Description: Tools for managing SingleCellExperiment objects as projects. 
  Includes functions for analysis and visualization of single-cell data. 
  Also included is a shiny app for visualization of pre-processed scRNA data.
License: MIT + file LICENSE
URL: https://github.com/whtns/chevreul,
    https://whtns.github.io/chevreul/
Date: 2024-03-05
BugReports: https://github.com/cobriniklab/chevreul/issues
Depends:
    R (>= 4.4.0),
    SingleCellExperiment,
    scater,
    shiny (>= 1.6.0),
    shinydashboard
Imports:
    SummarizedExperiment,
    annotables (>= 0.1.91),
    clustree,
    ComplexHeatmap (>= 2.5.4),
    DataEditR (>= 0.0.9),
    DBI,
    dplyr,
    DT,
    ensembldb,
    fs,
    future,
    glue,
    ggplotify,
    ggpubr,
    httr,
    janitor,
    magrittr,
    megadepth,
    methods,
    patchwork,
    plotly,
    rlang,
    RSQLite,
    shinyFiles,
    shinyhelper,
    shinyjs,
    shinyWidgets,
    tidyr,
    unglue,
    waiter,
    wiggleplotr (>= 1.13.1),
    purrr,
    batchelor,
    stringr,
    tibble,
    ggplot2,
    scran,
    AnnotationDbi,
    EnhancedVolcano,
    EnrichmentBrowser,
    harmony,
    scuttle,
    grDevices,
    graphics,
    stats,
    utils,
    pillar,
    cluster,
    circlize,
    bluster,
    EnsDb.Hsapiens.v86,
    EnsDb.Mmusculus.v79,
    scales,
    readr,
    velociraptor,
    LoomExperiment,
    chevreuldata,
    S4Vectors,
    base,
    grid,
    forcats
Suggests:
    BiocStyle,
    knitr,
    monocle3 (>= 0.2.1),
    RefManageR,
    rmarkdown,
    testthat (>= 3.0.0)
VignetteBuilder:
    knitr
Encoding: UTF-8
LazyData: false
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.1
biocViews: Coverage, RNASeq, Sequencing, Visualization, GeneExpression, Transcription, SingleCell
Config/testthat/edition: 3
lshep commented 3 months ago

All package dependencies must be on CRAN or Bioconductor. annotables is currently not on CRAN or Bioconductor and must not be used or referenced in the package.

I assume chevreuldata will be submitted once this issue can accept additional packages. I glanced at that github repo. All Bioconductor packages must include a vignette.

whtns commented 3 months ago

Thank you for taking a look at these packages. I removed the annotables dependency in chevreul and added a vignette in chevreuldata. I'd greatly appreciate further review.

whtns commented 3 months ago

adding an explicit reference to accompanying data package chevreuldata

AdditionalPackage: https://github.com/whtns/chevreuldata

bioc-issue-bot commented 3 months ago

Can't build unless issue is open and past pre-review stage, or issue is closed and 'TESTING' label is present.

lshep commented 3 months ago

A few questions:

Can default for saving or writing files be a tempdir() unless specified by a user?

Insteading of defining ~/.cache/ which isn't necessarily a default for all operating systems can you use tools::R_user_dir(which="cache") or rappdirs::user_cache_dir which would grab an appropriate path for a given OS.

Why is a chmod explicit set_permission_call necessary?

It looks like you import httr::GET but is it utilized anywhere?

whtns commented 2 months ago

Thank you for continuing to share feedback/shortcomings. I addressed the points you raised above in my last commit.

Can default for saving or writing files be a tempdir() unless specified by a user? I've removed any hardcoded filepaths previously used for saving

Insteading of defining ~/.cache/ which isn't necessarily a default for all operating systems can you use tools::R_user_dir(which="cache") or rappdirs::user_cache_dir which would grab an appropriate path for a given OS. I've replaced references to caches with rappdirs::user_cache_dir

Why is a chmod explicit set_permission_call necessary? removed

It looks like you import httr::GET but is it utilized anywhere? removed

lshep commented 1 month ago

When I try to run R CMD build I'm getting the following

 R CMD build chevreul
* checking for file 'chevreul/DESCRIPTION' ... OK
* preparing 'chevreul':
* checking DESCRIPTION meta-information ... OK
* installing the package to build vignettes
* creating vignettes ... ERROR
--- re-building ‘chevreul.Rmd’ using rmarkdown
--- finished re-building ‘chevreul.Rmd’

--- re-building ‘integration.Rmd’ using rmarkdown

Quitting from lines  at lines 71-77 [unnamed-chunk-2] (integration.Rmd)
Error: processing vignette 'integration.Rmd' failed with diagnostics:
file '/dataVolume/storage/single_cell_projects/sc_cone_devel/sc_cone_devel_organoid/20181001-DS-organoid-Hs_proj/output/velocyto/20181001-DS-organoid-Hs_proj.loom' does not exist
--- failed re-building ‘integration.Rmd’

--- re-building ‘preprocessing.Rmd’ using rmarkdown
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
--- finished re-building ‘preprocessing.Rmd’

--- re-building ‘shiny_app.Rmd’ using rmarkdown
--- finished re-building ‘shiny_app.Rmd’

--- re-building ‘visualization.Rmd’ using rmarkdown
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page

Quitting from lines  at lines 144-145 [unnamed-chunk-5] (visualization.Rmd)
Error: processing vignette 'visualization.Rmd' failed with diagnostics:
file '/dataVolume/storage/single_cell_projects/sc_cone_devel/sc_cone_devel_organoid/20181001-DS-organoid-Hs_proj/output/velocyto/20181001-DS-organoid-Hs_proj.loom' does not exist
--- failed re-building ‘visualization.Rmd’

SUMMARY: processing the following files failed:
  ‘integration.Rmd’ ‘visualization.Rmd’

Error: Vignette re-building failed.

It looks like you are hard linking to a file on your system that would not exist for a user.

whtns commented 4 weeks ago

I'm sorry I can't identify the source of the errors listed above in my current branch. I incremented the package version. Can you confirm that the check and build is run against the devel branch? thanks,

lshep commented 3 weeks ago

Yes it is

lorikern@jbcj433:~/PkgReview/PreReview/chevreul(devel)$ git remote -v
origin  https://github.com/whtns/chevreul/ (fetch)
origin  https://github.com/whtns/chevreul/ (push)

lorikern@jbcj433:~/PkgReview/PreReview/chevreul(devel)$ git pull
remote: Enumerating objects: 7, done.
remote: Counting objects: 100% (7/7), done.
remote: Compressing objects: 100% (2/2), done.
remote: Total 7 (delta 5), reused 7 (delta 5), pack-reused 0
Unpacking objects: 100% (7/7), 620 bytes | 38.00 KiB/s, done.
From https://github.com/whtns/chevreul
   e4d2858..da02a9c  sce        -> origin/sce
Already up to date.

lorikern@jbcj433:~/PkgReview/PreReview/chevreul(devel)$ cd ..
lorikern@jbcj433:~/PkgReview/PreReview$ R CMD build chevreul
* checking for file 'chevreul/DESCRIPTION' ... OK
* preparing 'chevreul':
* checking DESCRIPTION meta-information ... OK
* installing the package to build vignettes
* creating vignettes ... ERROR
--- re-building ‘chevreul.Rmd’ using rmarkdown
--- finished re-building ‘chevreul.Rmd’

--- re-building ‘integration.Rmd’ using rmarkdown

Quitting from lines 71-77 [unnamed-chunk-2] (integration.Rmd)
Error: processing vignette 'integration.Rmd' failed with diagnostics:
file '/dataVolume/storage/single_cell_projects/sc_cone_devel/sc_cone_devel_organoid/20181001-DS-organoid-Hs_proj/output/velocyto/20181001-DS-organoid-Hs_proj.loom' does not exist
--- failed re-building ‘integration.Rmd’

--- re-building ‘preprocessing.Rmd’ using rmarkdown
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
--- finished re-building ‘preprocessing.Rmd’

--- re-building ‘shiny_app.Rmd’ using rmarkdown
--- finished re-building ‘shiny_app.Rmd’

--- re-building ‘visualization.Rmd’ using rmarkdown
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page

Quitting from lines 144-145 [unnamed-chunk-5] (visualization.Rmd)
Error: processing vignette 'visualization.Rmd' failed with diagnostics:
file '/dataVolume/storage/single_cell_projects/sc_cone_devel/sc_cone_devel_organoid/20181001-DS-organoid-Hs_proj/output/velocyto/20181001-DS-organoid-Hs_proj.loom' does not exist
--- failed re-building ‘visualization.Rmd’

SUMMARY: processing the following files failed:
  ‘integration.Rmd’ ‘visualization.Rmd’

Error: Vignette re-building failed.
Execution halted
whtns commented 3 weeks ago

Ah, thank you very much. I had a mismatch between local and remote branches. The branch you are pulling is origin/sce in the above snippet. I've updated the local and remote branches and incremented version again. Can you try building again? Sorry for the trouble.

skevin@cobrinik-srt:~/rpkgs/chevreul$ git status
On branch devel
Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
        deleted:    docs/articles/Heatmap2.0.PNG
        deleted:    docs/articles/PlotCoverage2.0.PNG
        deleted:    docs/articles/violinPlot.PNG

skevin@cobrinik-srt:~/rpkgs/chevreul$ ..
skevin@cobrinik-srt:~/rpkgs$ R CMD build chevreul
* checking for file 'chevreul/DESCRIPTION' ... OK
* preparing 'chevreul':
* checking DESCRIPTION meta-information ... OK
* installing the package to build vignettes
* creating vignettes ... OK
* checking for LF line-endings in source and make files and shell scripts
* checking for empty or unneeded directories
* looking to see if a 'data/datalist' file should be added
* building 'chevreul_0.99.2.tar.gz'
lshep commented 3 weeks ago

Same

R CMD build chevreul
* checking for file 'chevreul/DESCRIPTION' ... OK
* preparing 'chevreul':
* checking DESCRIPTION meta-information ... OK
* installing the package to build vignettes
* creating vignettes ... ERROR
--- re-building ‘chevreul.Rmd’ using rmarkdown
--- finished re-building ‘chevreul.Rmd’

--- re-building ‘integration.Rmd’ using rmarkdown

Quitting from lines 71-77 [unnamed-chunk-2] (integration.Rmd)
Error: processing vignette 'integration.Rmd' failed with diagnostics:
file '/dataVolume/storage/single_cell_projects/sc_cone_devel/sc_cone_devel_organoid/20181001-DS-organoid-Hs_proj/output/velocyto/20181001-DS-organoid-Hs_proj.loom' does not exist
--- failed re-building ‘integration.Rmd’

--- re-building ‘preprocessing.Rmd’ using rmarkdown
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
--- finished re-building ‘preprocessing.Rmd’

--- re-building ‘shiny_app.Rmd’ using rmarkdown
--- finished re-building ‘shiny_app.Rmd’

--- re-building ‘visualization.Rmd’ using rmarkdown
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page

Quitting from lines 144-145 [unnamed-chunk-5] (visualization.Rmd)
Error: processing vignette 'visualization.Rmd' failed with diagnostics:
file '/dataVolume/storage/single_cell_projects/sc_cone_devel/sc_cone_devel_organoid/20181001-DS-organoid-Hs_proj/output/velocyto/20181001-DS-organoid-Hs_proj.loom' does not exist
--- failed re-building ‘visualization.Rmd’

SUMMARY: processing the following files failed:
  ‘integration.Rmd’ ‘visualization.Rmd’

Error: Vignette re-building failed.
Execution halted

In the vignette this seems to have to do with the plot_violin function. For what its worth it is also reproducible if I use devtools to load the package and just try to run that example as well

> load_all(".")
ℹ Loading chevreul
> chevreul_sce <- chevreuldata::human_gene_transcript_sce()
snapshotDate(): 2024-05-28
see ?chevreuldata and browseVignettes('chevreuldata') for documentation
loading from cache
> plot_violin(chevreul_sce, plot_var = "batch", features = "NRL")
Error in .Call2("C_h5getdimscales", filepath, name, scalename, PACKAGE = "HDF5Array") : 
  file '/dataVolume/storage/single_cell_projects/sc_cone_devel/sc_cone_devel_organoid/20181001-DS-organoid-Hs_proj/output/velocyto/20181001-DS-organoid-Hs_proj.loom' does not exist
whtns commented 2 weeks ago

Ok, I think I've resolved this problem. The example dataset (in accompanying experimenthub package chevreuldata) includes a SingleCellLoomExperiment assay for use with the velociraptor package. Because the source loom file is inaccessible on any other system even unrelated functions break. Because I don't know best practices to share loom files in this manner I've removed that assay from the dataset and excluded those functions from vignettes and examples.

lshep commented 2 weeks ago

You should not disable these examples and vignettes. If the data isn't loading, you should check out LoomExperiment where this class is defined and figure out the proper way. Exported functions need to be run/tested somewhere in the code base.

whtns commented 2 weeks ago

Ok thanks, I recognize the submission requirement to have included functions documented with examples. I've removed any dependency on LoomExperiment or velociraptor from the package

lshep commented 4 days ago

monocle3 does not appear to be on CRAN or Bioconductor. Bioconductor packages require all dependencies to be on CRAN or Bioconductor. You must remove the dependency from your package or request the monocle3 maintainers to officially submit the package.