Contributions
Contributions copied to clipboard
Bioconductor
oob
Update the following URL to point to the GitHub repository of the package you wish to submit to Bioconductor
- Repository: https://github.com/DimitriMeistermann/oob
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:
- [x] The 'devel' branch for new packages and features.
- [x] The stable 'release' branch, made available every six months, for bug fixes.
- [x] Bioconductor version control using Git (optionally via GitHub).
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.
Hi @DimitriMeistermann
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: oob
Type: Package
Title: oob: a toolbox for analyzing OMIC data, Out Of Bounds from any black box
Version: 0.99.0
Authors@R: person("Dimitri", "Meistermann", email = "[email protected]",role = c("aut", "cre"), comment=c(ORCID="0000-0001-6614-2325"))
Description: A toolbox for analyzing OMIC data, Out Of Bounds from any black box by avoiding the use of complex objects.
This package provide function for analyzing OMIC data, with a focus on plots and bulk/single-cell RNA-Seq.
In addition of providing diverse wrappers and utilities to ease the use of R with large datsets, it contains several unique features.
Among them, the TRIMAP dimension reduction implementated with reticulate and tools for enriching intersection of gene lists.
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: false
biocViews:
Software,
ResearchField,
Transcriptomics,
Clustering,
DimensionReduction
RoxygenNote: 7.3.2
Roxygen: list(markdown = TRUE)
Depends:
R (>= 4.4.0),
ggplot2,
stats,
ComplexHeatmap
Imports:
basilisk,
batchelor,
BiocParallel,
BiocGenerics,
circlize,
data.table,
dbscan,
ggbeeswarm,
ggrepel,
glmnet,
grDevices,
grid,
irlba,
labeling,
lsa,
MASS,
Matrix,
pvclust,
reshape2,
reticulate,
rgl,
Rcpp,
RcppArmadillo,
rlang,
scales,
scater,
scattermore,
scran,
SingleCellExperiment,
SummarizedExperiment,
stringr,
cli,
uwot,
graphics,
methods,
utils
Suggests:
knitr,
rmarkdown,
qualpalr,
WGCNA
VignetteBuilder: knitr
LinkingTo:
Rcpp,
RcppArmadillo
URL: https://github.com/DimitriMeistermann/oob
BugReports: https://github.com/DimitriMeistermann/oob/issues
StagedInstall: no
This package also need to interact with standard Bioconductor class structures for OMICs data like SummarizedExperiment/SingleCellExperiment.
Hi, Thank you for your feedback. I will add this week the support for SummarizedExperiment/SingleCellExperiment objects where I think it is relevant.
I updated the package to support SummarizedExperiment/SingleCellExperiment objects for the following functions:
- getMostVariableGenes
- getMarkers
- getMarkerGLMnet
- heatmap.DM
- plotExpr
- CPM
- TPMfullLength
- RPKM
- computeQCmetricSamples
- normDeseq
- oobFastMNN
- pcaAddSamples
- PCA
- fastPCA
- UMAP
- TRIMAP
- NMDS
- leidenFromUMAP
- pca2d
- proj2d
Thank you for your patience.
I'm getting the following ERROR when trying to build locally:
R CMD build oob
* checking for file 'oob/DESCRIPTION' ... OK
* preparing 'oob':
* checking DESCRIPTION meta-information ... OK
* cleaning src
* installing the package to build vignettes
-----------------------------------
* installing *source* package 'oob' ...
** using non-staged installation via StagedInstall field
ERROR: 'configure' exists but is not executable -- see the 'R Installation and Administration Manual'
* removing '/tmp/RtmpxNKJWP/Rinst6d496204304/oob'
-----------------------------------
ERROR: package installation failed
The problem should be resolved now, I apologize for this issue..
- [ ] I'm still getting the above ERROR
R CMD build oob
* checking for file 'oob/DESCRIPTION' ... OK
* preparing 'oob':
* checking DESCRIPTION meta-information ... OK
* cleaning src
* installing the package to build vignettes
-----------------------------------
* installing *source* package 'oob' ...
** using non-staged installation via StagedInstall field
ERROR: 'configure' exists but is not executable -- see the 'R Installation and Administration Manual'
* removing '/tmp/RtmpxNKJWP/Rinst6d496204304/oob'
-----------------------------------
ERROR: package installation failed
I changed locally to executable and ran build/check but I think you need to change the permission on the files and recommit them.
- [ ] Note the size of package should be reduced. It is rather large and above the size requirement for Bioconductor. You'll be able to do some with the R CMD Check recommendation
* checking data for ASCII and uncompressed saves ... WARNING
Note: significantly better compression could be obtained
by using R CMD build --resave-data
old_size new_size compress
bulkLogCounts.rda 4.0Mb 2.6Mb xz
geneLengthGRCh38.rda 166Kb 124Kb bzip2
humanGeneIDtable.rda 1.2Mb 411Kb xz
I'll move the package forward to see if it happens on the daily builder too.
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
[email protected]:packages/oob 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: 61b5448dbb3580f1593ee663bea18474b99820df
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: "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 24.04.1 LTS): oob_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
[email protected]:packages/oob 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: 104f11cb8000b10377dcfcf190e2d75522a2fa61
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: "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.
The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 24.04.1 LTS): oob_0.99.21.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
[email protected]:packages/oob 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: 8e5fcd7a62796ec8bbea882c4d3988aa93ae14cb
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Single Package Builder.
Congratulations! The package built without errors or warnings on all platforms.
Please see the build report for more details.
The following are build products from R CMD build on the Single Package Builder: Linux (Ubuntu 24.04.1 LTS): oob_0.99.22.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
[email protected]:packages/oob to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
A reviewer has been assigned to your package for an indepth review. Please respond accordingly to any further comments from the reviewer.
Thanks for your submission. The review will take some time, and I would like to start things off with some questions.
First, what is meant by "out of bounds"? You should explain this in the vignette and in the DESCRIPTION. The DESCRIPTION suggests that "avoiding complex objects" is a key distinction. Why is this advantageous? Are there new risks engendered by separating metadata from quantifications? SummarizedExperiment and derivates have a long history of successful use for many tasks. What is the benefit of "avoiding complexity"? What is meant by "any black box"?
Second, in the vignette we have:
When set `set.seed` is used the Random Number Generator give a different result
each time it is used. `getRandState`, `setRandState` are used for
retrieving/setting this precise seed state.
Why is new code needed for this? .Random.seed can be obtained directly for this purpose.
Third, with
Eventually, oobFastMNN can be used to perform a quick batch correction with the simple one matrix in, one matrix out format. ## Principal Component Analysis tools Principal Component Analysis can be performed with PCA or approximated with fastPCA with parameters optimized by default for RNA-Seq. Result can be then plotted with pca2d.
I would imagine that you are finding better throughput than existing methods in the sc-RNA-seq provided by scater, scran, scuttle and so forth. Can you document the advantages in your vignette with e.g. microbenchmark so that we have some context for understanding the role of these new components.
Thanks
This issue is being closed because there has been no progress for an extended period of time. You may reopen the issue when you have the time to actively participate in the review / submission process. Please also keep in mind that a package accepted to Bioconductor requires a commitment on your part to ongoing maintenance.
Thank you for your interest in Bioconductor.
Thank you for taking the time to review my package. I sincerely apologise for not taking the necessary time during the review process. After some thought, I feel that oob was not ready to be submitted to Bioconductor as it was too large and not focused enough on a specific goal.