Closed yavyx closed 2 years ago
Hi @yavyx
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: gemma.R
Title: A Wrapper for Gemma's Restful API
Version: 0.99.0
Authors@R:
c(person(given = "Javier", family = "Castillo-Arnemann",
role = c("aut"), email = "javiercastilloar@gmail.com",
comment = c(ORCID = "0000-0002-5626-9004")),
person(given = "Jordan", family = "Sicherman",
role = c("aut"), email = "jordan.sicherman@msl.ubc.ca",
comment = c(ORCID = "0000-0001-8160-4567")),
person(given = "Ogan", family = "Mancarci",
role = c("aut"), email = "ogan.mancarci@gmail.com",
comment = c(ORCID = "0000-0002-1452-0889")),
person(give = "Guillaume", family = "Poirier-Morency",
role = c("aut"), email = "poirigui@msl.ubc.ca",
comment = c(ORCID = "0000-0002-6554-0441")),
person(given = "Paul", family = "Pavlidis",
role = c("cre"), email = "paul@msl.ubc.ca",
comment = c(ORCID = "0000-0002-0426-5028")))
Description: Low- and high-level wrappers for Gemma's RESTful API. They enable
access to curated expression and differential expression data from over
10,000 published studies. Gemma is a web site, database and a set of tools for the
meta-analysis, re-use and sharing of genomics data, currently primarily
targeted at the analysis of gene expression profiles.
URL: https://pavlidislab.github.io/gemma.R/, https://github.com/PavlidisLab/gemma.R
License: Apache License (>= 2)
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.1.2
Imports:
magrittr,
glue,
memoise,
jsonlite,
data.table,
rlang,
utils,
stringr,
SummarizedExperiment,
Biobase,
tibble,
tidyr,
S4Vectors,
httr
Suggests:
testthat (>= 2.0.0),
rmarkdown,
knitr,
dplyr,
covr,
ggplot2,
ggrepel
Config/testthat/edition: 2
VignetteBuilder: knitr
biocViews:
ExperimentData,
ExpressionData,
RepositoryData,
GEO,
DiseaseModel,
OrganismData,
Homo_sapiens_Data,
Mus_musculus_Data,
Rattus_norvegicus_Data,
TechnologyData,
MicroarrayData,
SequencingData,
RNASeqData
The first link in the vignette does not resolve. The inner nodes are reversed. ubc.msl should be msl.ubc
Graphics seem unduly compressed in vignette rendering. Consider BiocStyle and the developer guidelines on vignette authoring.
Thanks for the feedback @vjcitn, it's addressed in the latest commits.
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
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/gemma.R
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Hi @yavyx,
Please see the build report for some issues that need to be addressed and ask here if you require assistance. Once we have a clean build, I will begin my review of gemma.R.
Cheers, Pete
Hi @PeteHaitch,
I addressed the issues from the build report and pushed the changes to the Github repo last week, but I can't push to the Bioconductor repo since I was not the maintainer in the initial submission. I e-mailed maintainer@bioconductor.org and bioc-devel@r-project.org last Wednesday to change the maintainer but I haven't heard back yet. I will forward the e-mail thread to you where I explain the situation better.
Best, Javier
Oh, thanks for letting me know and sorry that's it been an issue. I see the thread at https://stat.ethz.ch/pipermail/bioc-devel/2022-March/018843.html Hopefully someone from the core team will get back to you shortly (pinging @nturaga and @vjcitn)
Received a valid push on git.bioconductor.org; starting a build for commit id: 4c0e073d0c6d5adee893ddb71d7f7744c51acc5f
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/gemma.R
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: 6f752edd1c278ae844b58134e319a545b4e7c19a
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/gemma.R
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: 8ba70024137b643d230a99f9e8bcb0e8804c792b
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on Linux, Mac, and Windows.
Congratulations! The package built without errors or warnings on all platforms.
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/gemma.R
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Hi @PeteHaitch, I could finally figure out the SSH access and the build is passing now.
Thanks @yavyx! I'll have a review for you by the end of next week (but hopefully sooner).
Hi @yavyx,
My apologies, I'm a bit behind on my reviews but yours is next on my list.
A quick question, have you looked at using BiocFileCache for caching the downloads.
This is Bioconductor's preferred way of caching downloads; see https://contributions.bioconductor.org/r-code.html?q=biocfile#web-querying-and-file-caching.
The current caching uses memoise::memoise()
, which I don't think is capable of caching across sessions (my testing suggests this is the case but please correct me if I'm wrong)
Cheers, Pete
Hi @PeteHaitch,
No problem! I hadn't seen BiocFileCache, and yes, it looks like the better solution since memoise
indeed doesn't save data across sessions. However, replacing memoise with BiocFileCache would take quite a while and since I'm not working in the Pavlidis lab anymore, I honestly won't spend that much of my personal time on it. Would it be possible to make this change for version 1.1, after the review has passed and my replacement is hired? I want to clarify that I will fix any bugs or smaller issues that come up during the review process, but this specific change entails more work than I'm comfortable with since I have a new full time job.
Hi @yavyx,
I discussed this with the core team and their view is that a primary aim of this review process is to address these types of issues before acceptance and therefore that these changes would need to be made for the gemma.R to be accepted into Bioconductor. Unfortunately, in our experience it's not uncommon for people with the best of intentions to promise to make changes, but that this drops off as a priority due to other projects, jobs, etc.
We will temporarily close the issue and it can be re-opened once there is someone in place to develop and maintain the package as part of Bioconductor. Of course, none of this precludes @PavlidisLab hosting the package from the existing GitHub repo.
Cheers, Pete
Hi, I am a member of the @pavlidisLab. I was wondering if you'd be ok with continuing to use memoise
if we added persistent caching since that requires introducing minimal changes and includes the desired functionality
@lshep / @vjcitn: Must packages implementing caching of downloads use BiocFileCache or can they use their own system (here based on memoise)?
I would say as long as there is a caching mechanism and its verified to work that they could use that. BiocFileCache is strongly preferred but not required.
Would you like to proceed with the submission, @oganm? If so, we can re-open the issue and you then push the changes to the Bioconductor git server to generate a build on the Bioconductor's servers.
yes. the changes are tested, documented and merged
When making changes to your repository push to git@git.bioconductor.org:packages/gemma.R
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Dear @yavyx ,
We have reopened the issue to continue the review process. Please remember to push a version bump to git.bioconductor.org to trigger a new build.
was a bit confused with the ssh keys section. do you need the @yavyx to push it or can anyone do it?
I think it would need to be @yavyx but @lshep or @nturaga should be able to clarify
We have added @yavyx and javiercastilloar have push access to the package. The keys associated with those github accounts are currently active. Other keys could be added to either of these GitCredentials account to control additional access.
Received a valid push on git.bioconductor.org; starting a build for commit id: 34768b387f9a45192bebf94b8e66bee1e68528b5
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/gemma.R
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
@PeteHaitch Just pushed version 0.99.4 including the latest changes, it failed because @oganm needs to subscribe to the Biooconductor mailing lists. @oganm can you create an SSH keypair? I can add it to my Bioconductor account so you can push the changes yourself. I don't have access to the @PavlidisLab organization anymore so I can't push anything to the Github repo.
Received a valid push on git.bioconductor.org; starting a build for commit id: 281ed09a34317ae1abe1c03a6bbd8e28a24941ee
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/gemma.R
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: 4b9683a5acf34af2c954e149e2a4bc0a61315ebf
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/gemma.R
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: e00b202ef1f7e03200cd42ef404c0c57b6a49e8c
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/gemma.R
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: 18c2b0f865116f036e8d604b661b28e34d34e640
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/gemma.R
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: 4d4ea50d73207499f4a9b75edb3493ad34b382d7
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on Linux, Mac, and Windows.
Congratulations! The package built without errors or warnings on all platforms.
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/gemma.R
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
apologies for the spam. got a bit confused with the email used on my git session but should be all good now.
Thanks, @oganm. I will try to post an initial review within the next week. Please note that I will be on leave May 25 - June 8 and will be without internet access during that time.
Are you sure the memoisation is working as you intend? In particular, I can't seem to get memoising to a cache in my local filesystem to work. I basically tried to follow the advice in the 'Memoise data' and 'Changing defaults' sections of the vignette. Here's a documented version of what I tried:
library(gemma.R)
# On start-up, memoisation is not enabled and nor is the cache set.
getOption("gemma.memoise")
#> NULL
getOption("gemma.cache")
#> NULL
# Hence, no apparent memoisation (it's a bit faster the 2nd time, but I
# expected memoisation would mean the 2nd call is near instantaneous, so I
# presume the difference in time is not due to memoisation).
system.time(getDataset("GSE46416"))
#> user system elapsed
#> 5.741 0.440 13.594
system.time(getDataset("GSE46416"))
#> user system elapsed
#> 0.962 0.139 9.559
# Vignette says "To enable memoisation, simply set `memoised = TRUE` in the
# function call" but there's no way to do that in the call to `getDataset()`.
# So this fails.
getDataset("GSE46416", memoised = TRUE)
#> Error in getDataset("GSE46416", memoised = TRUE): unused argument (memoised = TRUE)
# Next, try the advice in the following paragraph of the vignette.
# Firstly, set a cache location.
options(gemma.cache = tools::R_user_dir('gemmaR', which = "cache"))
# So I've set the cache
getOption("gemma.cache")
#> [1] "/Users/Peter/Library/Caches/org.R-project.R/R/gemmaR"
# But not yet explicitly opted into memoisation
getOption("gemma.memoise")
#> NULL
# Therefore, still no apparent memoisation (but perhaps that's intended because
# I've only set the cache, not yet explicitly requested that memoisation occur).
system.time(getDataset("GSE46416"))
#> user system elapsed
#> 0.549 0.150 7.920
system.time(getDataset("GSE46416"))
#> user system elapsed
#> 0.478 0.114 7.118
# Okay, keep following advice in vignette for how to memoise by default.
options(gemma.memoise = TRUE)
getOption("gemma.memoise")
#> [1] TRUE
# But now this no longer works.
system.time(getDataset("GSE46416"))
#> Error in FUN(X[[i]], ...): object 'dataset' not found
#> Timing stopped at: 0.008 0.002 0.009
Created on 2022-05-24 by the reprex package (v2.0.1)
Aside: The vignette refers to both memoised = TRUE
and memoise = TRUE
as arguments to functions.
Received a valid push on git.bioconductor.org; starting a build for commit id: df4a0e0edd1f003f85bedfc2b85a8cbe78bb3827
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on Linux, Mac, and Windows.
Congratulations! The package built without errors or warnings on all platforms.
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/gemma.R
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
It seems like a few functions didn't have caching implemented but that is fixed now. Also addressed the typo at the vignette
Received a valid push on git.bioconductor.org; starting a build for commit id: 82e753372ecfc9f6c12aa520d19b930be306e698
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.