Closed js2264 closed 10 months ago
Hi @js2264
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: OHCA
Title: Orchestrating Hi-C analysis with Bioconductor
Version: 0.99.0
Date: 2023-04-14
Authors@R:
c(person(given = "Jacques",
family = "Serizay",
role = c("aut", "cre"),
email = "jacquesserizay@gmail.com",
comment = c(ORCID = "0000-0002-4295-0624")))
Description: The primary aim of this book is to introduce the R user to Hi-C
analysis. This book starts with key concepts important for the analysis
of chromatin conformation capture and then presents Bioconductor tools that
can be leveraged to process, analyze, explore and visualize Hi-C data.
License: MIT + file LICENSE
URL: https://github.com/js2264/OHCA
BugReports: https://github.com/js2264/OHCA/issues
Depends:
R (>= 4.3),
HiCExperiment,
HiCool,
HiContacts,
HiContactsData,
DNAZooData,
fourDNData
Imports:
plyinteractions,
terra,
Rfast,
WGCNA,
diffHic,
strawr,
multiHiCcompare,
TopDom,
GOTHiC,
BSgenome.Hsapiens.UCSC.hg38,
ggbio,
cowplot,
patchwork,
fs,
knitr,
rebook,
quarto,
sessioninfo
biocViews:
HiC,
DNA3DStructure,
FunctionalGenomics
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
BiocType: Book
VignetteBuilder: knitr
SystemRequirements: quarto
LazyData: false
Your package has been added to git.bioconductor.org to continue the pre-review process. A build report will be posted shortly. Please fix any ERROR and WARNING in the build report before a reviewer is assigned or provide a justification on why you feel the ERROR or WARNING should be granted an exception.
IMPORTANT: Please read this documentation for setting up remotes to push to git.bioconductor.org. All changes should be pushed to git.bioconductor.org moving forward. It is required to push a version bump to git.bioconductor.org to trigger a new build report.
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
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Single Package Builder.
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.
The following are build products from R CMD build on the Single Package Builder: ERROR before build products produced.
Links above 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/OHCA
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Received a valid push on git.bioconductor.org; starting a build for commit id: 7cbd04df359ec9cba86b83f282761c5cdabb41f7
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Single Package Builder.
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.
The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 22.04.2 LTS): OHCA_0.99.1.tar.gz
Links above 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/OHCA
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Hi @lshep, thanks for pre-checking the book package. The SPB now reports:
R CMD check
BiocCheck()
(Package tarball exceeds the Bioconductor size requirement): this is due to the large size of the compiled book; BiocCheck()
, about packages listed in Imports
not added to NAMESPACE (no documentation is provided in this package, since this is a book package, hence no @import(From) tags). Do you have any recommendation on how to address these remaining issues, or is it ok to continue with the process and get the review started? Many thanks for your help and advice.
@lshep kind reminder, is there any way I can help with this submission?
Sorry I normally moderate once or twice a week. I'll look at moving this forward later today, tomorrow at the latest
A reviewer has been assigned to your package for an indepth review. Please respond accordingly to any further comments from the reviewer.
Hi @PeteHaitch, thanks for agreeing to review this package. You'll notice that this package does not include code in R/, it's a book package, built with BiocBook
. The content of the book (unrendered) is located at inst/pages/
in qmd
files, you can browse them directly, you don't need the BiocBook
package installed for that.
The rendered book is currently hosted by GitHub in the gh-pages
branch and is being served at the following URL: https://js2264.github.io/OHCA. The HTML code is also included in the build archive returned by the BBS, in inst/doc/book
, if you want to check what is actually generated by the BBS (rather than Github machines).
Please let me know if you have any question while reviewing this package !
Hi Jacques,
It's exciting to see another book being contributed to Bioconductor!
I need to let you know that this review is unlikely to happen until the new year. I have 5 days left of work for the year, and quite a few commitments due in those days, and I'll then be on leave until January 8. From my brief look at the package/book, it looks in great shape, and with the next Bioconductor release not for several months I have no doubt that it will be straightforward to ensure this is part of the next release.
Cheers, Pete
Hi Pete, thank you for informing me and no worries at all, just let me know next year when you have time to look at the package/book in more depth. Until then, happy holiday break :) On Dec 13, 2023, 6:20β―AM +0100, Peter Hickey @.***>, wrote:
Hi Jacques, It's exciting to see another book being contributed to Bioconductor! I need to let you know that this review is unlikely to happen until the new year. I have 5 days left of work for the year, and quite a few commitments due in those days, and I'll then be on leave until January 8. From my brief look at the package/book, it looks in great shape, and with the next Bioconductor release not for several months I have no doubt that it will be straightforward to ensure this is part of the next release. Cheers, Pete β Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.Message ID: @.***>
Received a valid push on git.bioconductor.org; starting a build for commit id: c7942c6ccc737596756f5ad2610e3fc754c54b0a
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Single Package Builder.
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.
The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 22.04.2 LTS): OHCA_0.99.2.tar.gz
Links above 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/OHCA
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Hi @js2264,
Thank you for submitting OHCA to Bioconductor. As I said, it's exciting to see another book being contributed to Bioconductor!
Overall, the book is in good shape and close to being ready for acceptance.
In my review below I have separated the issues into Required and Recommended points that I would ask you to address before the package can be accepted. Would you please provide line-by-line comments to my initial review so that I know what changes I'm looking for in my re-review.
Cheers, Pete
BiocCheck::BiocCheck()
), which is a 68M tar.gz on my system, and about the size of the source code, with 26M of images in inst/pages/images/
. The OSCA books (which I'm most familiar with) have much smaller source code (< 1M) [I can't check the size of the tarball right now]. I'll defer to @lshep for how much of an issue this is.Depends
(instead of under Imports
)? I think that code chunks that rely on these packages should begin with the relevant library()
calls, anyway, which negates the need for these to be in Depends
(I think).SystemRequirements
?sessionInfo()
at the end of each chapter; cf. the OSCA sub-books.Imports
of DESCRIPTION
to avoid note from R CMD check
("* checking for unstated dependencies in vignettes ... NOTE '::' or ':::' import not declared from: βBiocStyleβ
"")BiocManager::install()
and only from CRAN/BioC (i.e. not GitHub) (cf. the advice in https://jserizay.com/OHCA/docs/devel/#developers). Please change the text accordingly or explain in the review the need for pak and installation from GitHub.HiCool::HiCool()
in https://jserizay.com/OHCA/docs/devel/pages/principles.html#executing-hicool and https://jserizay.com/OHCA/docs/devel/pages/topological-features.html#identifying-loops failed to create the conda environment: <snip>
</snip>
installation finished.
+ /Users/peter/Library/Caches/org.R-project.R/R/basilisk/1.15.1/0/bin/conda 'create' '--yes' '--prefix' '/Users/peter/Library/Caches/org.R-project.R/R/basilisk/1.15.1/HiCool/1.3.0/env' 'python=3.7.12' '--quiet' '-c' 'conda-forge' '-c' 'bioconda'
Collecting package metadata (current_repodata.json): ...working... done
Solving environment: ...working... failed with repodata from current_repodata.json, will retry with next repodata source.
Collecting package metadata (repodata.json): ...working... done
Solving environment: ...working... failed
PackagesNotFoundError: The following packages are not available from current channels:
- python=3.7.12
Current channels:
- https://conda.anaconda.org/conda-forge/osx-arm64
- https://conda.anaconda.org/conda-forge/noarch
- https://conda.anaconda.org/bioconda/osx-arm64
- https://conda.anaconda.org/bioconda/noarch
- https://repo.anaconda.com/pkgs/main/osx-arm64
- https://repo.anaconda.com/pkgs/main/noarch
- https://repo.anaconda.com/pkgs/r/osx-arm64
- https://repo.anaconda.com/pkgs/r/noarch
To search for alternate channels that may provide the conda package you're
looking for, navigate to
https://anaconda.org
and use the search bar at the top of the page.
Error: Error creating conda environment '/Users/peter/Library/Caches/org.R-project.R/R/basilisk/1.15.1/HiCool/1.3.0/env' [exit code 1]
library(multiHiCcompare); (Multicoolf_wt <- HiContactsData('yeast_wt', 'mcool'); coolf_eco1 <- HiContactsData('yeast_eco1', 'mcool')
). The reader will not see this code but they need to run it to enable subsequent code chunks to succeed (e.g., the code beginning in https://jserizay.com/OHCA/docs/devel/pages/interoperability.html#multihiccompare).
BiocCheck::BiocCheck()
:
inst/requirements.yml
and why is it needed?NAMESPACE
since it's empty? The various OSCA sub-books don't have have a NAMESPACE
file.as.matrix()
coercion method should return a matrix (i.e. dense matrix) object not a Matrix (here, a dgTMatrix sparse matrix) object; see https://jserizay.com/OHCA/docs/devel/pages/parsing.html#coercing-hicexperiment-objects. This coercion method should really be as(hic, "TsparseMatrix")
, which is more accurate and more explicit about the coercion.
[ ] Again, not an issue with OHCA directly, instead, here with HiContacts, but shouldn't the file
in the caption of plotMatrix(hic, compare.to = hic2)
(https://jserizay.com/OHCA/docs/devel/pages/visualization.html#side-by-side-maps) include the path to both files and not just the path to one of the files?cowplot::plot_grid()
to create multi-panel figures.
suppressPackageStartupMessages(library(OHCA))
sessioninfo::session_info()
#> β Session info βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
#> setting value
#> version R Under development (unstable) (2024-01-03 r85769)
#> os macOS Ventura 13.6.1
#> system aarch64, darwin20
#> ui X11
#> language (EN)
#> collate en_US.UTF-8
#> ctype en_US.UTF-8
#> tz Australia/Melbourne
#> date 2024-01-08
#> pandoc 3.1.1 @ /Applications/RStudio.app/Contents/Resources/app/quarto/bin/tools/ (via rmarkdown)
#>
#> β Packages βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
#> package * version date (UTC) lib source
#> abind 1.4-5 2016-07-21 [1] CRAN (R 4.4.0)
#> AnnotationDbi 1.65.2 2023-11-03 [1] Bioconductor
#> AnnotationHub * 3.11.1 2023-12-11 [1] Bioconductor 3.19 (R 4.4.0)
#> basilisk 1.15.1 2023-11-20 [1] Bioconductor 3.19 (R 4.4.0)
#> basilisk.utils 1.15.1 2023-12-04 [1] Bioconductor 3.19 (R 4.4.0)
#> beeswarm 0.4.0 2021-06-01 [1] CRAN (R 4.4.0)
#> Biobase 2.63.0 2023-10-24 [1] Bioconductor
#> BiocFileCache * 2.11.1 2023-10-26 [1] Bioconductor
#> BiocGenerics * 0.49.1 2023-11-01 [1] Bioconductor
#> BiocIO 1.13.0 2023-10-24 [1] Bioconductor
#> BiocManager 1.30.22 2023-08-08 [1] CRAN (R 4.4.0)
#> BiocParallel 1.37.0 2023-10-24 [1] Bioconductor
#> BiocVersion 3.19.1 2023-10-26 [1] Bioconductor
#> Biostrings 2.71.1 2023-10-25 [1] Bioconductor
#> bit 4.0.5 2022-11-15 [1] CRAN (R 4.4.0)
#> bit64 4.0.5 2020-08-30 [1] CRAN (R 4.4.0)
#> bitops 1.0-7 2021-04-24 [1] CRAN (R 4.4.0)
#> blob 1.2.4 2023-03-17 [1] CRAN (R 4.4.0)
#> bookdown 0.37 2023-12-01 [1] CRAN (R 4.4.0)
#> cachem 1.0.8 2023-05-01 [1] CRAN (R 4.4.0)
#> cli 3.6.2 2023-12-11 [1] CRAN (R 4.4.0)
#> codetools 0.2-19 2023-02-01 [1] CRAN (R 4.4.0)
#> colorspace 2.1-0 2023-01-23 [1] CRAN (R 4.4.0)
#> crayon 1.5.2 2022-09-29 [1] CRAN (R 4.4.0)
#> curl 5.2.0 2023-12-08 [1] CRAN (R 4.4.0)
#> data.table 1.14.10 2023-12-08 [1] CRAN (R 4.4.0)
#> DBI 1.2.0 2023-12-21 [1] CRAN (R 4.4.0)
#> dbplyr * 2.4.0 2023-10-26 [1] CRAN (R 4.4.0)
#> DelayedArray 0.29.0 2023-10-24 [1] Bioconductor
#> digest 0.6.33 2023-07-07 [1] CRAN (R 4.4.0)
#> dir.expiry 1.11.0 2023-12-04 [1] Bioconductor 3.19 (R 4.4.0)
#> DNAZooData * 1.3.0 2023-10-31 [1] Bioconductor
#> dplyr 1.1.4 2023-11-17 [1] CRAN (R 4.4.0)
#> evaluate 0.23 2023-11-01 [1] CRAN (R 4.4.0)
#> ExperimentHub * 2.11.1 2023-12-11 [1] Bioconductor 3.19 (R 4.4.0)
#> fansi 1.0.6 2023-12-08 [1] CRAN (R 4.4.0)
#> fastmap 1.1.1 2023-02-24 [1] CRAN (R 4.4.0)
#> filelock 1.0.3 2023-12-11 [1] CRAN (R 4.4.0)
#> fourDNData * 1.3.0 2023-10-31 [1] Bioconductor
#> fs 1.6.3 2023-07-20 [1] CRAN (R 4.4.0)
#> generics 0.1.3 2022-07-05 [1] CRAN (R 4.4.0)
#> GenomeInfoDb 1.39.5 2023-12-28 [1] Bioconductor 3.19 (R 4.4.0)
#> GenomeInfoDbData 1.2.11 2023-10-30 [1] Bioconductor
#> GenomicRanges 1.55.1 2023-10-29 [1] Bioconductor
#> ggbeeswarm 0.7.2 2023-04-29 [1] CRAN (R 4.4.0)
#> ggplot2 3.4.4 2023-10-12 [1] CRAN (R 4.4.0)
#> ggrastr 1.0.2 2023-06-01 [1] CRAN (R 4.4.0)
#> glue 1.6.2 2022-02-24 [1] CRAN (R 4.4.0)
#> gtable 0.3.4 2023-08-21 [1] CRAN (R 4.4.0)
#> HiCExperiment * 1.3.0 2023-10-24 [1] Bioconductor
#> HiContacts * 1.5.0 2023-10-24 [1] Bioconductor
#> HiContactsData * 1.5.2 2023-11-21 [1] Bioconductor 3.19 (R 4.4.0)
#> HiCool * 1.3.0 2023-10-24 [1] Bioconductor
#> hms 1.1.3 2023-03-21 [1] CRAN (R 4.4.0)
#> htmltools 0.5.7 2023-11-03 [1] CRAN (R 4.4.0)
#> htmlwidgets 1.6.4 2023-12-06 [1] CRAN (R 4.4.0)
#> httr 1.4.7 2023-08-15 [1] CRAN (R 4.4.0)
#> InteractionSet 1.31.0 2023-10-24 [1] Bioconductor
#> IRanges 2.37.0 2023-10-24 [1] Bioconductor
#> jsonlite 1.8.8 2023-12-04 [1] CRAN (R 4.4.0)
#> KEGGREST 1.43.0 2023-10-24 [1] Bioconductor
#> knitr 1.45 2023-10-30 [1] CRAN (R 4.4.0)
#> lattice 0.22-5 2023-10-24 [1] CRAN (R 4.4.0)
#> lazyeval 0.2.2 2019-03-15 [1] CRAN (R 4.4.0)
#> lifecycle 1.0.4 2023-11-07 [1] CRAN (R 4.4.0)
#> magrittr 2.0.3 2022-03-30 [1] CRAN (R 4.4.0)
#> Matrix 1.6-4 2023-11-30 [1] CRAN (R 4.4.0)
#> MatrixGenerics 1.15.0 2023-10-24 [1] Bioconductor
#> matrixStats 1.2.0 2023-12-11 [1] CRAN (R 4.4.0)
#> memoise 2.0.1 2021-11-26 [1] CRAN (R 4.4.0)
#> munsell 0.5.0 2018-06-12 [1] CRAN (R 4.4.0)
#> OHCA * 0.99.2 2024-01-07 [1] Bioconductor
#> pillar 1.9.0 2023-03-22 [1] CRAN (R 4.4.0)
#> pkgconfig 2.0.3 2019-09-22 [1] CRAN (R 4.4.0)
#> plotly 4.10.3 2023-10-21 [1] CRAN (R 4.4.0)
#> png 0.1-8 2022-11-29 [1] CRAN (R 4.4.0)
#> purrr 1.0.2 2023-08-10 [1] CRAN (R 4.4.0)
#> R6 2.5.1 2021-08-19 [1] CRAN (R 4.4.0)
#> rappdirs 0.3.3 2021-01-31 [1] CRAN (R 4.4.0)
#> Rcpp 1.0.11 2023-07-06 [1] CRAN (R 4.4.0)
#> RCurl 1.98-1.13 2023-11-02 [1] CRAN (R 4.4.0)
#> readr 2.1.4 2023-02-10 [1] CRAN (R 4.4.0)
#> reprex 2.0.2 2022-08-17 [1] CRAN (R 4.4.0)
#> reticulate 1.34.0 2023-10-12 [1] CRAN (R 4.4.0)
#> rhdf5 2.47.1 2023-11-29 [1] Bioconductor 3.19 (R 4.4.0)
#> rhdf5filters 1.15.1 2023-11-06 [1] Bioconductor
#> Rhdf5lib 1.25.1 2023-12-11 [1] Bioconductor 3.19 (R 4.4.0)
#> rjson 0.2.21 2022-01-09 [1] CRAN (R 4.4.0)
#> rlang 1.1.2 2023-11-04 [1] CRAN (R 4.4.0)
#> rmarkdown 2.25 2023-09-18 [1] CRAN (R 4.4.0)
#> rmdformats 1.0.4 2022-05-17 [1] CRAN (R 4.4.0)
#> RSpectra 0.16-1 2022-04-24 [1] CRAN (R 4.4.0)
#> RSQLite 2.3.4 2023-12-08 [1] CRAN (R 4.4.0)
#> rstudioapi 0.15.0 2023-07-07 [1] CRAN (R 4.4.0)
#> S4Arrays 1.3.1 2023-11-27 [1] Bioconductor 3.19 (R 4.4.0)
#> S4Vectors 0.41.3 2024-01-01 [1] Bioconductor 3.19 (R 4.4.0)
#> scales 1.3.0 2023-11-28 [1] CRAN (R 4.4.0)
#> sessioninfo 1.2.2 2021-12-06 [1] CRAN (R 4.4.0)
#> SparseArray 1.3.2 2023-12-28 [1] Bioconductor 3.19 (R 4.4.0)
#> strawr 0.0.91 2023-03-29 [1] CRAN (R 4.4.0)
#> stringi 1.8.3 2023-12-11 [1] CRAN (R 4.4.0)
#> stringr 1.5.1 2023-11-14 [1] CRAN (R 4.4.0)
#> SummarizedExperiment 1.33.1 2023-11-28 [1] Bioconductor 3.19 (R 4.4.0)
#> tibble 3.2.1 2023-03-20 [1] CRAN (R 4.4.0)
#> tidyr 1.3.0 2023-01-24 [1] CRAN (R 4.4.0)
#> tidyselect 1.2.0 2022-10-10 [1] CRAN (R 4.4.0)
#> tzdb 0.4.0 2023-05-12 [1] CRAN (R 4.4.0)
#> utf8 1.2.4 2023-10-22 [1] CRAN (R 4.4.0)
#> vctrs 0.6.5 2023-12-01 [1] CRAN (R 4.4.0)
#> vipor 0.4.7 2023-12-18 [1] CRAN (R 4.4.0)
#> viridisLite 0.4.2 2023-05-02 [1] CRAN (R 4.4.0)
#> vroom 1.6.5 2023-12-05 [1] CRAN (R 4.4.0)
#> withr 2.5.2 2023-10-30 [1] CRAN (R 4.4.0)
#> xfun 0.41 2023-11-01 [1] CRAN (R 4.4.0)
#> XVector 0.43.0 2023-10-24 [1] Bioconductor
#> yaml 2.3.8 2023-12-11 [1] CRAN (R 4.4.0)
#> zlibbioc 1.49.0 2023-10-24 [1] Bioconductor
#>
#> [1] /Library/Frameworks/R.framework/Versions/4.4-arm64/Resources/library
#>
#> ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
Hi @PeteHaitch, thanks for your thorough review! I'll start working on it and will come back to you by the end of the week!
Hi @PeteHaitch, I have tried to address all your comments to the best of my ability. Please see below:
Required
- [x] I'm a bit concerned about the size of the built package (as is BiocCheck::BiocCheck()), which is a 68M tar.gz on my system, and about the size of the source code, with 26M of images in inst/pages/images/. The OSCA books (which I'm most familiar with) have much smaller source code (< 1M) [I can't check the size of the tarball right now]. I'll defer to @lshep for how much of an issue this is.
I have already discussed with @lshep regarding the size of the package bundle when I submitted it two months ago. She seemed to be ok. Regardless, I have reduced the size of the source code to ~6Mb. The size of the built package is large due to the many high-resolution Hi-C plots generated in the book.
- [x] Do all those packages really need to be listed under Depends (instead of under Imports)? I think that code chunks that rely on these packages should begin with the relevant library() calls, anyway, which negates the need for these to be in Depends (I think).
I have moved packages from Depends to Imports
- [x] Does quarto really need to be listed under SystemRequirements?
I believe it is needed, yes. The whole thing with these books is to trigger the Makefile
in vignettes/
, which itself triggers quarto render ...
.
- [x] Please include sessionInfo() at the end of each chapter; cf. the OSCA sub-books.
- [x] Please include BiocStyle in Imports of DESCRIPTION to avoid note from R CMD check ("* checking for unstated dependencies in vignettes ... NOTE '::' or ':::' import not declared from: βBiocStyleβ"")
- [x] It is strongly recommended that packages are only installed using BiocManager::install() and only from CRAN/BioC (i.e. not GitHub) (cf. the advice in https://jserizay.com/OHCA/docs/devel/#developers). Please change the text accordingly or explain in the review the need for pak and installation from GitHub.
Source code was modified to address the points hereabove.
- [x] Remember to update links from https://js2264.github.io/OHCA/ to https://bioconductor.org/books/OHCA/ (I think that will be the canonical URL) once available.
If this is ok with you, I will update these links once the book is successfully built by the BBS. Thanks for the reminder!
- [x] I identified some (unevaluated) code examples that failed for me when I ran them interactively. I'm on an M1 Mac (session info at bottom of by review), so this could be specific to my system, but please do your best to ensure that all code chunks (evaluated or not) could be run by an interested user.
- [x] Calls to HiCool::HiCool() in https://jserizay.com/OHCA/docs/devel/pages/principles.html#executing-hicool and https://jserizay.com/OHCA/docs/devel/pages/topological-features.html#identifying-loops failed to create the conda environment
The two points above relate to the fact that HiCool
functions relies on a basilisk
environment
which cannot be set up for Windows/ARM chips. I have added an explicit warning here: https://github.com/js2264/OHCA/commit/418ff19535f73f7586c7016022ca406216582046#diff-303b76bc343633986fd062e0c50b037b597f1a982d29b3769add89b9f1eb6787R379-R390
- [x] More generally, please make explicit all chunks that are not evaluated. E.g., many of the chunks in https://jserizay.com/OHCA/docs/devel/pages/principles.html are not evaluated but this not explicitly noted (unlike what you have done for the 'Workflows' chapters).
- [x] There is un-echoed but evaluated code in https://jserizay.com/OHCA/docs/devel/pages/interoperability.html#multihiccompare (e.g., library(multiHiCcompare); (Multicoolf_wt <- HiContactsData('yeast_wt', 'mcool'); coolf_eco1 <- HiContactsData('yeast_eco1', 'mcool')). The reader will not see this code but they need to run it to enable subsequent code chunks to succeed (e.g., the code beginning in https://jserizay.com/OHCA/docs/devel/pages/interoperability.html#multihiccompare).
I have improved the book so that as many chunks as possible are executed,
and I made explicit whenever the chunks were not evaluated.
In particular, two out of three workflows are now fully evaluated.
The remaining unevaluated workflow relies on many files and file architecture, and I don't see any straightforward approach to execute it... Also, it introduces hicrep
, which has been deprecated and is thus
not directly available from Bioconductor.
- [x] More generally, why not echo the code chunks at the start of each chapter?
I have wrapped these chunks in an initial collapsed section.
- [x] An incomplete sentence: "Contrary to functions presented in the previous chapter, the functions described in this chapter are not: ..."; please fix. (https://jserizay.com/OHCA/docs/devel/pages/interactions-centric.html)
- [x] The workflow chapters consist entirely(?) of unevaluated code. I appreciate that many of these steps require large files and the data processing takes a long time, but have you considered some ways to evaluate at least some of the code chunks in these chapters.
- [x] If downloading the files is feasible (I'm not sure how large these files are) you could illustrate how to use BiocFileCache to cache such downloads (e.g., in https://jserizay.com/OHCA/docs/devel/pages/workflow-yeast.html#recovering-data-from-sra)
- [x] If processing the reads with HiCool is not practical (e.g., in https://jserizay.com/OHCA/docs/devel/pages/workflow-yeast.html#processing-reads-with-hicool), then could you make the (merged) HiCExperiment available from ExperimentHub? Would that make subsequent code chunks amenable to being evaluated as part of the package build?
- [x] Are the data in https://jserizay.com/OHCA/docs/devel/pages/workflow-centros.html#importing-hi-c-data-and-plotting-contact-matrices publicly available? If so, where from? Please emphasise that a user will need to update the path accordingly if they download these files and want to run the code themselves.
See my point above.
- [x] From BiocCheck::BiocCheck(): Please update R version dependency from 4.3 to 4.4.0.
Done!
Recommended
- [x] I strongly recommend running a spell checker, e.g., 'combinaison' and 'hereinabove' in https://jserizay.com/OHCA/docs/devel/pages/principles.html#binning-pairs-into-a-matrix.
Done, thank you for the suggestion.
- [x] What's inst/requirements.yml and why is it needed ?
- [x] You could perhaps just ditch the NAMESPACE since it's empty? The various OSCA sub-books don't have have a NAMESPACE file.
These files are not needed, I deleted them.
- [x] This is incorrect/imprecise: "[GRanges] extend the data.frame object and have four required pieces of information" (https://jserizay.com/OHCA/docs/devel/pages/data-representation.html#granges-fundamentals). When talking about classes in R, if class Y 'extends' class X it means that Y is an X with some extra features. E.g., a SpatialExperiment object is a SummarizedExperiment object with some extra features. However, the GRanges class is not at all formally related to the data.frame class. Please rephrase this sentence.
This was a mistake, thanks for the correction.
- [x] This isn't an issue with OHCA directly but rather with HiCExperiment: An as.matrix() coercion method should return a matrix (i.e. dense matrix) object not a Matrix (here, a dgTMatrix sparse matrix) object; see https://jserizay.com/OHCA/docs/devel/pages/parsing.html#coercing-hicexperiment-objects. This coercion method should really be as(hic, "TsparseMatrix"), which is more accurate and more explicit about the coercion.
I have fixed this here: https://github.com/js2264/HiCExperiment/commit/97c881008b736e7513cf3f30b8fb8f65f9a64f06
- [x] Again, not an issue with OHCA directly, instead, here with HiContacts, but shouldn't the file in the caption of plotMatrix(hic, compare.to = hic2) (https://jserizay.com/OHCA/docs/devel/pages/visualization.html#side-by-side-maps) include the path to both files and not just the path to one of the files?
I have fixed this here: https://github.com/js2264/HiContacts/commit/7c817540f4973aa365e6159b36f3b6618dc42c54
- [x] Perhaps just use patchwork rather than a combination of patchwork and cowplot::plot_grid() to create multi-panel figures.
Addressed when possible.
Received a valid push on git.bioconductor.org; starting a build for commit id: f575d43297691d5dd3169267ec832361f37fab95
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Single Package Builder.
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.
The following are build products from R CMD build on the Single Package Builder: ERROR before build products produced.
Links above 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/OHCA
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Thanks @js2264, I aim to re-review within the next week or 2.
Received a valid push on git.bioconductor.org; starting a build for commit id: 6db115986a23a088c63b9d45fd887eece5278e7c
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Single Package Builder.
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.
The following are build products from R CMD build on the Single Package Builder: ERROR before build products produced.
Links above 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/OHCA
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Received a valid push on git.bioconductor.org; starting a build for commit id: b03e08cf01d5176ad204f3af807feece2c0c8227
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Single Package Builder.
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.
The following are build products from R CMD build on the Single Package Builder: ERROR before build products produced.
Links above 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/OHCA
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
@js2264 Could you please take a look at the build report to try to fix the errors and get a clean build. I'll need that before I can proceed with the review
Received a valid push on git.bioconductor.org; starting a build for commit id: 77846c897517dd82e8ddcf5fa022312bae309345
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Single Package Builder.
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.
The following are build products from R CMD build on the Single Package Builder: ERROR before build products produced.
Links above 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/OHCA
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Received a valid push on git.bioconductor.org; starting a build for commit id: 1aad2cad105b1a234ffc5c40b118d870683eef85
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Single Package Builder.
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.
The following are build products from R CMD build on the Single Package Builder: ERROR before build products produced.
Links above 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/OHCA
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Hi @PeteHaitch,
I have updated HiContactsData
package to be able to execute most workflow steps, but it still needs to propagate to Bioconductor:devel
. In the meantime:
bioconductor_docker:devel
with a HiContactsData
install from my github): https://github.com/js2264/OHCA/actions/runs/7615873328/artifacts/1186568804Do you think it would be possible to finalize the review ASAP? The manuscript is in press and ideally I would like to update the URL to point to Bioconductor-supported URL, rather than my own Github Pages. Many thanks for your help!
Thank you for making the requested changes, @js2264. With the latest version of HiContactsData I can confirm the package builds on my laptop (macOS M1).
I'm now happy to accept OHCA into Bioconductor. Congratulations and thank you for your contribution!
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.
Thanks @PeteHaitch for your prompt answer, glad to hear you managed to build on M1. Do you know (or maybe @lshep?) what happens next for the book package? In particular, the OHCA book was already listed in the Bioconductor list of books, but the URL is pointing to my github version: any way to update this to point to https://bioconductor.org/books/release/OHCA/ (when the book is actually successfully built on the BBS)? Thanks again for everything!
Lori knows best, but my understanding is that it won't available from https://bioconductor.org/books/release/OHCA/ until after the next BioC release (usually in April).
However, once Lori does the ingest of newly accepted packages (this usually happens at the end of each week) then it will be built on the main Bioconductor Build System (BBS) and, if it builds successfully, be propagated to https://bioconductor.org/books/devel/OHCA/, which could happen by some point next week. I think at this point it will also be available from https://bioconductor.org/books/OHCA/, which will re-direct to the 'devel' version until the 'release' version is made in April.
The default branch of your GitHub repository has been added to Bioconductor's git repository as branch devel.
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/js2264.keys is not empty), then no further steps are required. Otherwise, do the following:
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("OHCA")
. The package 'landing page' will be created at
https://bioconductor.org/packages/OHCA
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.
lets check all these endpoints next week tue/wed after the books have a chance to run on monday (it will miss todays build). If it is not appearing I can investigate then.
https://bioconductor.org/books/devel/OHCA/ is live and https://bioconductor.org/books/OHCA/ redirects to it π₯³
@js2264 Congrats! Build reports for books are available at https://bioconductor.org/checkResults/devel/books-LATEST/ and https://bioconductor.org/checkResults/release/books-LATEST/ Both reports get updated 3 times a week (on Mondays, Wednesdays, and Fridays).
@lshep Where do we open an issue to request changing the link on this page?
BTW @js2264, about this ERROR. Should we install xelatex on our Linux servers? @jwokaty I think we can get it with sudo apt install texlive-xetex
.
Thanks @hpages @lshep @PeteHaitch for your help with this! V happy to have this book live, checked and served by Bioconductor π
@hpages - re: thanks for raising this ERROR. quarto
complains that xelatex
is not installed because it attempts to render the book as a pdf
as well, but there is not really any use in rendering a pdf by Bioconductor servers, AFAICT. I'll try and remove this option to see if this fixes the ERROR.
@hpages its on the new website so it would be bioconductor.org github repo specifically this page -- I updated it this morning.
Thanks @lshep
@js2264 I agree that the PDF version of the book is of limited value. FWIW we still distribute the package source tarballs of the books, and people can install them like any other package with BiocManager::install()
. It's up to you to decide if you want the tarball to contain the PDF or not.
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]'
[x] I understand that by submitting my package to Bioconductor, the package source and all review commentary are visible to the general public.
[x] I have read the Bioconductor Package Submission instructions. My package is consistent with the Bioconductor Package Guidelines.
[x] I understand Bioconductor Package Naming Policy and acknowledge Bioconductor may retain use of package name.
[x] I understand that a minimum requirement for package acceptance is to pass R CMD check and R CMD BiocCheck with no ERROR or WARNINGS. Passing these checks does not result in automatic acceptance. The package will then undergo a formal review and recommendations for acceptance regarding other Bioconductor standards will be addressed.
[x] My package addresses statistical or bioinformatic issues related to the analysis and comprehension of high throughput genomic data.
[x] I am committed to the long-term maintenance of my package. This includes monitoring the support site for issues that users may have, subscribing to the bioc-devel mailing list to stay aware of developments in the Bioconductor community, responding promptly to requests for updates from the Core team in response to changes in R or underlying software.
[x] I am familiar with the Bioconductor code of conduct and agree to abide by it.
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.