Closed YuanningEric closed 2 years ago
Hi @YuanningEric
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: EpiMix.data
Title: Data for the EpiMix package
Version: 0.99.0
Authors@R: c(
person("Yuanning", "Zheng", email = c("yuanning.zheng@gmail.com"), role = c("aut", "cre")),
person("Olivier", "Gevaert", email = c("ogevaert@stanford.edu"), role = c("aut"))
)
Maintainer: Yuanning Zheng <yuanning.zheng@gmail.com>
Description:
Supporting data for the EpiMix R package.
It include:
- HM450_lncRNA_probes.rda
- HM450_miRNA_probes.rda
- EPIC_lncRNA_probes.rda
- EPIC_miRNA_probes.rda
- EpigenomeMap.rda
- LUAD.sample.annotation
- TCGA_BatchData
- MET.data
- mRNA.data
- microRNA.data
- lncRNA.data
- Sample_EpiMixResults_lncRNA
- Sample_EpiMixResults_miRNA
- Sample_EpiMixResults_Regular
That is.
License: GPL-3
Encoding: UTF-8
LazyData: true
Depends:
R (>= 3.5.0)
biocViews: AssayDomainData, TechnologyData, OrganismData
NeedsCompilation: no
RoxygenNote: 7.1.2
VignetteBuilder: knitr
Please do not use the name vignette.Rmd for your vignette. Also, when attempting to check your package I get
* creating vignettes ... ERROR
--- re-building ‘vignette.Rmd’ using rmarkdown
Loading required package: EpiMix.data
Quitting from lines 297-317 (vignette.Rmd)
Error: processing vignette 'vignette.Rmd' failed with diagnostics:
could not find function "EpiMix"
--- failed re-building ‘vignette.Rmd’
Please be sure to install your package and check it with R CMD check on a clean system so that another person attempting this will succeed.
Hi Vince,
Thanks for the review !
I have renamed the vignette.md. I tried to build the package in a clean environment but could not reproduce the issue. It was very surprised to see the error, because "EpiMix" is one of the main exported functions of this package. So, if the package has been installed, then the function should exist.
Could you please fetch the updated repository and build it again?
Thanks!
@vjcitn Please also note that the "EpiMix.data" package is the supporting data package of "EpiMix". They are stored in two different git repositories. I assume that the error occurred when you tried to build the main "EpiMix" package.
I need to understand this better.
else {
cat("Searching lncRNA data for:", CancerSite, "\n")
url = "https://github.com/gevaertlab/ncRNA_pancancer_new/raw/main/"
destfile = paste0(TargetDirectory, "/", CancerSite, "_lncRNA.txt")
downloader::download(paste0(url, CancerSite, "_lncRNA.txt"),
destfile)
MAdirectories = destfile
}
return(MAdirectories = MAdirectories)
}
<bytecode: 0x11600ef30>
Is your package downloading data from github? Instead you have to use ExperimentHub.
@lshep ^^
@vjcitn / @YuanningEric Bioconductor does not allow data to be stored on github. It minimally must be on a public server at an Institution or something like Zenodo and implement a caching like system (like BiocFileCache) for managing downloads. Bioconductor provides opportunity for hosting data through Bioconductor provided location. We encourage data to be distributed through the ExperimentHub. Please see https://bioconductor.org/packages/devel/bioc/vignettes/HubPub/inst/doc/CreateAHubPackage.html
@vjcitn Hi, Vince! I have started the procedures to upload these data to ExperimentHub. After this has been accomplished, I will modify the corresponding code and notify you about the change. At the mean time, please let us know if there are any other problems we need to fix for our package. Thanks a lot!
Thanks for this. I guess a basic question is why you had to write code to use firehose instead of reusing code in TCGAbiolinks. Are the data of interest not provided in curatedTCGAData?
RTCGAToolbox also has similar functionality. Had you looked at these?
@vjcitn Thanks for your question, Vince!
I took a close look at both packages you mentioned. The TCGAbiolinks
first downloads data from the GDC portal, which includes one patient data per file, then it combined all the patient files together for additional preprocessing. This takes significant higher amount of time and disk space than using the firehose, from which the downloaded data has already been a single zipped file including preprocessed data for all the patients.
The RTCGAToolbox uses a very similar function than what we wrote. The reason we used our own code is that we built our current package by extending our previous Bioconductor package, called MethylMix
. We did reuse a few bottom functionalities from MethylMix, because we know that those functions worked well. This also reduces the number of package dependency by avoiding to downloading another package.
Hope this helps, and please let me know if you have any other questions!
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/EpiMix.data
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: 54f9a747833374c11e80d5e7fd69ed58878c2e33
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/EpiMix.data
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
The data package has been built. Here is our main package:
Please see the proper way to submit the related package at https://github.com/Bioconductor/Contributions#circular-dependencies you need to use an AdditionalPackage:
indication
AdditionalPackage: https://github.com/gevaertlab/EpiMix
Hi @YuanningEric, Thanks for submitting your additional package: https://github.com/gevaertlab/EpiMix. We are taking a quick look at it and you will hear back from us soon.
@lshep @Kayla-Morrell
Hi Kayla! I saw there is a deadline for the new package to be built on Bioconductor in order for catching up the release of V3.15. Could you please move our additional package to the repo?
Both our data package and the main (additional) package have been scrutinized during the pre-check phase (see comments above), and we want them to be released with Bioc 3.15 instead of waiting for the next release period.
We appreciate your time and effort!
Please be aware EpiMix currently has a mixture of biocViews. Please only use one hierarchy. I will manually force this in and designate EpiMix a software package.
@YuanningEric There also seems to be a discrepancy in our credentials app -- I assume the correct spelling of your email is eric2021@stanford.edu
-- currently in the BiocCredentails app it is erci2021@stanford.edu
. Would you like me to update the credentials app for you? I can't finish the processing without the name mismatch (and the biocViews) corrected.
@YuanningEric There also seems to be a discrepancy in our credentials app -- I assume the correct spelling of your email is
eric2021@stanford.edu
-- currently in the BiocCredentails app it iserci2021@stanford.edu
. Would you like me to update the credentials app for you? I can't finish the processing without the name mismatch (and the biocViews) corrected.
@lshep Thanks for checking this! Yes, please use eric2021@stanford.edu
Additional Package has been approved for building.
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.
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/EpiMix
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
@lshep Hi ! From the BiocCheck report, I saw an error: At least 80% of man pages documenting exported objects must have runnable examples" What if some of my functions take a really long time to run or need to save exported objects to the file system? For example, one of my functions is to download the gene expression data from the TCGA project. In this case, which folder should I save the download file?
Functions generally need to be run somewhere vignette or examples or tests. One of the reasons I think @vjcitn also mentioned the TCGAbiolinks is it already utilizes Bioconductor standards like experimenthub and biicfilecache. Anything downloaded from the internet should have a caching mechanism to download; that way the expensive download is done once and the a user can use the cached file in subsequent runs and only redownload if the file changes. I would see about implementing biocfilecache.
Also we would consider skipping running that example but implement a long test that would run and test functionality. http://contributions.bioconductor.org/long-tests.html
Received a valid push on git.bioconductor.org; starting a build for commit id: fccd2d45b2974b93b3b917a0a65ecd0937dca87b
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/EpiMix
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: 18cfb0dbacb6f8768772ce0145babedd317e79e7
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/EpiMix
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
@lshep Thanks a lot for your advice! In a future release, we will consider to using TCGAbiolinks or RTCGAToolBox as mentioned by @vjcitn . Now, our package has passed the R CMD check
. The only error and warning arising from the BiocCheck
is that we need to test more chunks in vignette and/or examples.
For those functions I tested in the vignette, do I need to test it again in the function examples?
In addition, I plan to move those functions taking long time to run to the long test
as you mentioned, but this may take me a few days. Whether this will affect the release of our package with Bioc 3.15?
Received a valid push on git.bioconductor.org; starting a build for commit id: f174fd441d333f650b16b3740f4d092baf32d223
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/EpiMix
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: 9278d7b9b6cad4e98b2e5887aa193d974e77e640
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: "TIMEOUT". 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/EpiMix
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: 5e1eab0e8be04988864ed3b839f1fbc2b836823a
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: "TIMEOUT". 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/EpiMix
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: e2f054324088524953de43c32bc956599ec62911
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/EpiMix
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Hi @lshep @Kayla-Morrell, I have included the vast majority of functions as runnable examples in the Vignette. Since there is a time limit for R CMD check
, the functions that have been run in the Vignette were not included as runnable examples in the man pages. Can you accept our package?
Thanks!
@YuanningEric - We do not accept packages simply based off the build report, there is a formal review process that must take place. I will begin reviewing both packages and post back here with required/suggested changes that should be made to the package before being accepted. I will attempt to get the review posted within the next week.
Best, Kayla
@Kayla-Morrell Thanks, Kayla! Please let me know if you have any questions
@YuanningEric - Thank you for submitting to Bioconductor. Please see the initial review of the packages 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.
eval = FALSE
sections of code besides the
installation code chunk.sessionInfo()
.library()
in each code chunk, once is
sufficient. The same goes for the data()
calls.Error in wilcox.test.default(expr.high.values, expr.low.values, alternative = ifelse(correlation == :
not enough 'y' observations
>
plots$CorrelationPlot
then a plot is produced.Best, Kayla
Received a valid push on git.bioconductor.org; starting a build for commit id: bc0858c228189eabb0ed096c535ad1b8deb2ab7c
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: "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. 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/EpiMix
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: e88ab724904a811371f197f9e9fc7535f98253d0
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/EpiMix.data
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: b513ed445514343379669c978bd508a5cfd02676
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: "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. 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/EpiMix
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
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.