Closed golddc closed 3 months ago
Hi @golddc
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: knowYourCG
Type: Package
Title: Functional analysis of DNA methylome datasets
Version: 0.99.0
Authors: Wanding Zhou, David Goldberg, Ethan Jacob Moyer
Authors@R: c(person("Zhou", "Wanding", role=c("aut"),
email="ZHOUW3@chop.edu"),
person("Goldberg", "David", role=c("aut","cre"),
email="golddc72@pennmedicine.upenn.edu",
comment=c(ORCID="0000-0002-9622-4708")),
person("Moyer","Ethan",role=c("ctb"),
email="ejm374@drexel.edu")
)
Description: knowYourCG automates the functional analysis of DNA
methylation data. The package tests the enrichment of discrete CpG probes
across thousands of curated biological and technical features. GSEA-like
analysis can be performed on continuous methylation data query sets.
knowYourCG can also take beta matrices as input to perform feature
aggregation and unsupervised methylation module detection.
Depends: R (>= 4.3.0),
sesameData
License: MIT + file LICENSE
VignetteBuilder: knitr
Encoding: UTF-8
LazyData: false
RoxygenNote: 7.2.3
Imports:
dplyr,
methods,
rlang,
GenomicRanges,
gprofiler2,
IRanges,
ggplot2,
reshape2,
S4Vectors,
stats,
stringr,
tibble,
igraph,
utils,
wheatmap,
GenomeInfoDb
biocViews:
Epigenetics,
DNAMethylation,
MethylationArray
Suggests:
testthat (>= 3.0.0),
ggrepel,
SummarizedExperiment,
rmarkdown,
knitr,
sesame,
rnndescent
Config/testthat/edition: 3
You currently download or suggest downloading additional annotation data from github. Downloading from personal github and dropboxes are not allowed. A smaller dataset should be included in the package or the data should be hosted on a trusted public server like zenodo, AWS S3 buckets, Azure Microsoft Data Lakes, etc , minimally an institutional level server. See also AnnotationHub for a Bioconductor distributed solution
Hello,
I have removed the part of our vignette that suggests downloading annotation data from github. Thanks for reviewing the package and for bringing this issue to my attention. Please let me know if there are any other issues.
David
From: lshep @.> Reply-To: Bioconductor/Contributions @.> Date: Monday, October 2, 2023 at 11:08 AM To: Bioconductor/Contributions @.> Cc: "Goldberg, David (NGG)" @.>, Mention @.***> Subject: [External] Re: [Bioconductor/Contributions] knowYourCG (Issue #3197)
You currently download or suggest downloading additional annotation data from github. Downloading from personal github and dropboxes are not allowed. A smaller dataset should be included in the package or the data should be hosted on a trusted public server like zenodo, AWS S3 buckets, Azure Microsoft Data Lakes, etc , minimally an institutional level server. See also AnnotationHub for a Bioconductor distributed solution
— Reply to this email directly, view it on GitHubhttps://github.com/Bioconductor/Contributions/issues/3197#issuecomment-1743197247, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AVO7FP5YRZGRHULKHKLG3VDX5LKFJAVCNFSM6AAAAAA5NFIBD2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONBTGE4TOMRUG4. You are receiving this because you were mentioned.Message ID: @.***>
This is still in the man pages?
Hi,
My apologies, I forgot about some of the text in the documentation. There should no longer be any references to downloading data from github. Thank you.
David
From: lshep @.> Reply-To: Bioconductor/Contributions @.> Date: Friday, October 6, 2023 at 10:28 AM To: Bioconductor/Contributions @.> Cc: "Goldberg, David (NGG)" @.>, Mention @.***> Subject: [External] Re: [Bioconductor/Contributions] knowYourCG (Issue #3197)
This is still in the man pages?
— Reply to this email directly, view it on GitHubhttps://github.com/Bioconductor/Contributions/issues/3197#issuecomment-1750776047, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AVO7FPYS334LNRVPTWDNG6TX6AIPPAVCNFSM6AAAAAA5NFIBD2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONJQG43TMMBUG4. You are receiving this because you were mentioned.Message ID: @.***>
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 Build System.
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 Bioconductor Build System: macOS 12.6.5 Monterey: knowYourCG_0.99.0.tar.gz Linux (Ubuntu 22.04.2 LTS): knowYourCG_0.99.0.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/knowYourCG
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
All dependencies must be on CRAN or Bioconductor in order to be used. rnndescent does not appear to be on CRAN or Bioconductor and will have to be removed.
I have removed the functions using rnndescent and updated the description file so that the package is no longer suggested. Hopefully, that clears up the errors. Thanks!
David
From: lshep @.> Reply-To: Bioconductor/Contributions @.> Date: Tuesday, October 10, 2023 at 7:53 AM To: Bioconductor/Contributions @.> Cc: "Goldberg, David (NGG)" @.>, Mention @.***> Subject: [External] Re: [Bioconductor/Contributions] knowYourCG (Issue #3197)
All dependencies must be on CRAN or Bioconductor in order to be used. rnndescent does not appear to be on CRAN or Bioconductor and will have to be removed.
— Reply to this email directly, view it on GitHubhttps://github.com/Bioconductor/Contributions/issues/3197#issuecomment-1755201549, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AVO7FP6BSYRVDLVHR7DX3R3X6UZJVAVCNFSM6AAAAAA5NFIBD2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONJVGIYDCNJUHE. You are receiving this because you were mentioned.Message ID: @.***>
Please follow instructions for pushing to git.bioconductor.org with a valid version bump to trigger a new build. See https://github.com/Bioconductor/Contributions/issues/3197#issuecomment-1755175540
Received a valid push on git.bioconductor.org; starting a build for commit id: 2a5cbc56c5b5f6779f04935f26168c79a08025c2
Received a valid push on git.bioconductor.org; starting a build for commit id: 2a5cbc56c5b5f6779f04935f26168c79a08025c2
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Build System.
On one or more platforms, the build results were: "ABNORMAL". 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 Bioconductor Build System: 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/knowYourCG
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Build System.
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 Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): knowYourCG_0.99.0.tar.gz macOS 12.6.5 Monterey: knowYourCG_0.99.0.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/knowYourCG
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: 18c730100820ea5ec6656d0c9988ddc5145dbc21
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Build System.
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 Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): knowYourCG_0.99.2.tar.gz macOS 12.6.5 Monterey: knowYourCG_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/knowYourCG
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Hello,
I created the upstream remote and pushed to git.bioconductor.org.
I am receiving one warning in the build report that there are package files that exceed the 5MB size limit. However, to my knowledge there are no files that are this large. Please let me know if there is any guidance on how to proceed with this warning. Thank you.
David
From: lshep @.> Reply-To: Bioconductor/Contributions @.> Date: Wednesday, October 11, 2023 at 8:02 AM To: Bioconductor/Contributions @.> Cc: "Goldberg, David (NGG)" @.>, Mention @.***> Subject: [External] Re: [Bioconductor/Contributions] knowYourCG (Issue #3197)
Please follow instructions for pushing to git.bioconductor.org with a valid version bump to trigger a new build. See #3197 (comment)https://github.com/Bioconductor/Contributions/issues/3197#issuecomment-1755175540
— Reply to this email directly, view it on GitHubhttps://github.com/Bioconductor/Contributions/issues/3197#issuecomment-1757542532, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AVO7FP2VJPKTAL4KWNG2V7TX62DF7ANCNFSM6AAAAAA5NFIBDY. You are receiving this because you were mentioned.Message ID: @.***>
If you run BiocCheck locally, it will give you an output directory with a more verbose check that list the offending files.
Received a valid push on git.bioconductor.org; starting a build for commit id: ab2a5ef7efe08d218aab0812219efe84d31876b4
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on the Bioconductor Build System.
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 Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): knowYourCG_0.99.3.tar.gz macOS 12.6.5 Monterey: knowYourCG_0.99.3.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/knowYourCG
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.
Hi David, @golddc Thank you for your submission. Please see the review below. Best, Marcel
Authors
field, the Authors@R
is sufficient.BugReports
and URL
fieldsSuggests
field. Why is
sesameData
a hard dependency?4.4.0
or greater.KYCG_
in function names. The full
address of a function already contains this information, i.e.,
knowYourCG::KYCG_annoProbes
. Is there potential for function name
clobbering? Perhaps use more descriptive names.|>
pipe rather than importing %>%
from dplyr
.sesameDataCache()
automatically downloads all 91 EH
resources. Is there a way to only download the necessary datasets or are
all datasets needed?vignettes/KYCG.Rmd:L#220
? Perhaps
save the set of names into a vector. Ideally, the returned data should have
those as the first few variables in the data.SummarizedExperiment
as the main representation for the
betas
input and allow compatibility for matrix
class inputs as well.query
which seems to
be a different input depending on the function.knowYourCG
.covr::package_coverage
but this may have
been due to not downloading all 91 resources to my machine.Thank you Marcel. I am currently working on addressing these points.
Regarding the R version dependency, can this be switched to 4.4.0 when this version is officially released? Or will I need to install the development version now? Please let me know, thanks.
From: Marcel Ramos @.> Reply-To: Bioconductor/Contributions @.> Date: Monday, November 6, 2023 at 2:51 PM To: Bioconductor/Contributions @.> Cc: "Goldberg, David (NGG)" @.>, Mention @.***> Subject: [External] Re: [Bioconductor/Contributions] knowYourCG (Issue #3197)
Hi David, @golddchttps://github.com/golddc Thank you for your submission. Please see the review below. Best, Marcel
knowYourCG #3197https://github.com/Bioconductor/Contributions/issues/3197 DESCRIPTION
NAMESPACE
vignettes
R
tests
— Reply to this email directly, view it on GitHubhttps://github.com/Bioconductor/Contributions/issues/3197#issuecomment-1796228215, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AVO7FP3JJUWGM6Q2VSNNCULYDE5RFAVCNFSM6AAAAAA5NFIBD2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTOOJWGIZDQMRRGU. You are receiving this because you were mentioned.Message ID: @.***>
Received a valid push on git.bioconductor.org; starting a build for commit id: 65d13112472043eba6d9e97294275255ef0c1d1f
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/knowYourCG
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: 5f1fc65611ed442194862eb005fb8a9d04bb7f4f
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: macOS 12.7.1 Monterey: knowYourCG_0.99.5.tar.gz Linux (Ubuntu 22.04.2 LTS): knowYourCG_0.99.5.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/knowYourCG
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: 7fff87f3fd068a7d10979fe9f5c282bceec6fe27
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: macOS 12.7.1 Monterey: knowYourCG_0.99.6.tar.gz Linux (Ubuntu 22.04.2 LTS): knowYourCG_0.99.6.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/knowYourCG
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Hi Marcel,
I have incorporated most of the feedback from the review into our submission. Please see below for some of the comments
I think there is more flexibility when downloading all datasets, and it is not overly time or memory consuming. A user may not know in advance which resources or platform they want to use for testing. I think it’s best for discovery to use our default setting of testing all datasets, which requires downloading all EH resources. Additionally, once all the resources are cached one could work offline without needing to download again from EH.
David
From: Marcel Ramos @.> Reply-To: Bioconductor/Contributions @.> Date: Monday, November 6, 2023 at 2:51 PM To: Bioconductor/Contributions @.> Cc: "Goldberg, David (NGG)" @.>, Mention @.***> Subject: [External] Re: [Bioconductor/Contributions] knowYourCG (Issue #3197)
Hi David, @golddchttps://github.com/golddc Thank you for your submission. Please see the review below. Best, Marcel
knowYourCG #3197https://github.com/Bioconductor/Contributions/issues/3197 DESCRIPTION
NAMESPACE
vignettes
R
tests
— Reply to this email directly, view it on GitHubhttps://github.com/Bioconductor/Contributions/issues/3197#issuecomment-1796228215, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AVO7FP3JJUWGM6Q2VSNNCULYDE5RFAVCNFSM6AAAAAA5NFIBD2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTOOJWGIZDQMRRGU. You are receiving this because you were mentioned.Message ID: @.***>
@golddc Hi David,
Thank you Marcel. I am currently working on addressing these points. Regarding the R version dependency, can this be switched to 4.4.0 when this version is officially released? Or will I need to install the development version now? Please let me know, thanks.
You should be using R devel as indicated in the Bioconductor Guidelines https://contributions.bioconductor.org/use-devel.html#use-devel
I think there is more flexibility when downloading all datasets, and it is not overly time or memory consuming. A user may not know in advance which resources or platform they want to use for testing. I think it’s best for discovery to use our default setting of testing all datasets, which requires downloading all EH resources. Additionally, once all the resources are cached one could work offline without needing to download again from EH.
Please selectively download only the necessary resources for the example. Excessive downloads require additional costs from Bioconductor especially across multiple users. It is best to minimize the downloads from cloud resources.
I would prefer to keep the plotting functions in the package. Most functions only depend on ggplot and directly handle the output of the package’s analysis functions, so I think it is convenient. Please let me know if this is ok, alternatively I can try to reduce some of the dependencies.
Analysis and plotting packages are generally separate entities. Some users may only be interested in the analysis portion of the package and may not want to install the plotting components. With user experience in mind, it is best to separate functionalities into modular packages. See the recommendation below.
> pkgndep(package="knowYourCG")
'knowYourCG', version 0.99.6
- 122 packages are required for installing 'knowYourCG'.
- 157 packages are required if installing packages listed in all fields in DESCRIPTION.
Following adjustment could be performed:
- Found 1 function is imported from a heavy parent 'gprofiler2'. Moving 'gprofiler2''
to 'Suggests' will reduce 24 dependencies.
Moving all mentioned packages to 'Suggests' will reduce the dependency packages from 122 to 98.
Thank you Marcel I am working on updating the package
From: Marcel Ramos @.> Reply-To: Bioconductor/Contributions @.> Date: Thursday, December 28, 2023 at 10:57 AM To: Bioconductor/Contributions @.> Cc: "Goldberg, David (NGG)" @.>, Mention @.***> Subject: [External] Re: [Bioconductor/Contributions] knowYourCG (Issue #3197)
Thank you Marcel. I am currently working on addressing these points. Regarding the R version dependency, can this be switched to 4.4.0 when this version is officially released? Or will I need to install the development version now? Please let me know, thanks.
You should be using R devel as indicated in the Bioconductor Guidelines https://contributions.bioconductor.org/use-devel.html#use-devel
I think there is more flexibility when downloading all datasets, and it is not overly time or memory consuming. A user may not know in advance which resources or platform they want to use for testing. I think it’s best for discovery to use our default setting of testing all datasets, which requires downloading all EH resources. Additionally, once all the resources are cached one could work offline without needing to download again from EH.
Please selectively download only the necessary resources for the example. Excessive downloads require additional costs from Bioconductor especially across multiple users. It is best to minimize the downloads from cloud resources.
I would prefer to keep the plotting functions in the package. Most functions only depend on ggplot and directly handle the output of the package’s analysis functions, so I think it is convenient. Please let me know if this is ok, alternatively I can try to reduce some of the dependencies.
Analysis and plotting packages are generally separate entities. Some users may only be interested in the analysis portion of the package and may not want to install the plotting components. With user experience in mind, it is best to separate functionalities into modular packages. See the recommendation below.
pkgndep(package="knowYourCG")
'knowYourCG', version 0.99.6
122 packages are required for installing 'knowYourCG'.
157 packages are required if installing packages listed in all fields in DESCRIPTION.
Following adjustment could be performed:
Found 1 function is imported from a heavy parent 'gprofiler2'. Moving 'gprofiler2''
to 'Suggests' will reduce 24 dependencies.
Moving all mentioned packages to 'Suggests' will reduce the dependency packages from 122 to 98.
— Reply to this email directly, view it on GitHubhttps://github.com/Bioconductor/Contributions/issues/3197#issuecomment-1871298139, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AVO7FP62KMKEX5BMWEIK3RLYLWJF7AVCNFSM6AAAAAA5NFIBD2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQNZRGI4TQMJTHE. You are receiving this because you were mentioned.Message ID: @.***>
Received a valid push on git.bioconductor.org; starting a build for commit id: 4ce4d17f1b47fe0ef3cb95f5632cb97a18826b84
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/knowYourCG
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: e6e89113dac2092974af56dc9b6448f1e2e5b852
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 22.04.3 LTS): knowYourCG_0.99.8.tar.gz macOS 12.7.1 Monterey: knowYourCG_0.99.8.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/knowYourCG
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: 201dff0621dc495c6b5bf5a50af6332ca4ef51d9
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 22.04.3 LTS): knowYourCG_0.99.9.tar.gz macOS 12.7.1 Monterey: knowYourCG_0.99.9.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/knowYourCG
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Hi Marcel,
The plotting functions have been removed and will be included in a separate package in the future. The dependency heavy import has been moved to suggests, and only the used database sets are retrieved from experiment hub. Please let me know if there are any more suggestions. Thank you
David
From: Marcel Ramos @.> Reply-To: Bioconductor/Contributions @.> Date: Thursday, December 28, 2023 at 10:57 AM To: Bioconductor/Contributions @.> Cc: "Goldberg, David (NGG)" @.>, Mention @.***> Subject: [External] Re: [Bioconductor/Contributions] knowYourCG (Issue #3197)
Thank you Marcel. I am currently working on addressing these points. Regarding the R version dependency, can this be switched to 4.4.0 when this version is officially released? Or will I need to install the development version now? Please let me know, thanks.
You should be using R devel as indicated in the Bioconductor Guidelines https://contributions.bioconductor.org/use-devel.html#use-devel
I think there is more flexibility when downloading all datasets, and it is not overly time or memory consuming. A user may not know in advance which resources or platform they want to use for testing. I think it’s best for discovery to use our default setting of testing all datasets, which requires downloading all EH resources. Additionally, once all the resources are cached one could work offline without needing to download again from EH.
Please selectively download only the necessary resources for the example. Excessive downloads require additional costs from Bioconductor especially across multiple users. It is best to minimize the downloads from cloud resources.
I would prefer to keep the plotting functions in the package. Most functions only depend on ggplot and directly handle the output of the package’s analysis functions, so I think it is convenient. Please let me know if this is ok, alternatively I can try to reduce some of the dependencies.
Analysis and plotting packages are generally separate entities. Some users may only be interested in the analysis portion of the package and may not want to install the plotting components. With user experience in mind, it is best to separate functionalities into modular packages. See the recommendation below.
pkgndep(package="knowYourCG")
'knowYourCG', version 0.99.6
122 packages are required for installing 'knowYourCG'.
157 packages are required if installing packages listed in all fields in DESCRIPTION.
Following adjustment could be performed:
Found 1 function is imported from a heavy parent 'gprofiler2'. Moving 'gprofiler2''
to 'Suggests' will reduce 24 dependencies.
Moving all mentioned packages to 'Suggests' will reduce the dependency packages from 122 to 98.
— Reply to this email directly, view it on GitHubhttps://github.com/Bioconductor/Contributions/issues/3197#issuecomment-1871298139, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AVO7FP62KMKEX5BMWEIK3RLYLWJF7AVCNFSM6AAAAAA5NFIBD2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQNZRGI4TQMJTHE. You are receiving this because you were mentioned.Message ID: @.***>
Hi David, @golddc
Please test a Suggest
ed package's availability with requireNamespace
in the functions that use the package's functionality. For example,
myfun <- function(...) {
if (!requireNamespace("gprofiler2", quietly = TRUE))
stop("Install the 'gprofiler2' to use this function")
gprofiler2::fun()
}
Everything else looks good.
Best regards, Marcel
Received a valid push on git.bioconductor.org; starting a build for commit id: 7eeccf0da683e5c4659e75aef28cbd363d7ccc9e
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 22.04.3 LTS): knowYourCG_0.99.91.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/knowYourCG
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Hi Marcel,
I updated the function using gprofiler to include the availability check and error handler and the package is building successfully. Hope everything is all set. Thanks.
David
From: Marcel Ramos @.> Reply-To: Bioconductor/Contributions @.> Date: Friday, February 16, 2024 at 2:48 PM To: Bioconductor/Contributions @.> Cc: "Goldberg, David (NGG)" @.>, Mention @.***> Subject: [External] Re: [Bioconductor/Contributions] knowYourCG (Issue #3197)
Hi David, @golddchttps://github.com/golddc
Please test a Suggested package's availability with requireNamespace in the functions that use the package's functionality. For example,
myfun <- function(...) {
if (!requireNamespace("gprofiler2", quietly = TRUE))
stop("Install the 'gprofiler2' to use this function")
gprofiler2::fun()
}
Everything else looks good.
Best regards, Marcel
— Reply to this email directly, view it on GitHubhttps://github.com/Bioconductor/Contributions/issues/3197#issuecomment-1949224350, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AVO7FP24BRDIPS7UKCP75BLYT6ZV5AVCNFSM6AAAAAA5NFIBD2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNBZGIZDIMZVGA. You are receiving this because you were mentioned.Message ID: @.***>
Thanks @golddc I tried to check the package and got an error:
> cg_lists <- getDBs("MM285.TFBS")
Selected the following database groups:
1. KYCG.MM285.TFBSconsensus.20220116
Error in stopAndCache(title) :
| File KYCG.MM285.TFBSconsensus.20220116 either not found or needs to be cached to be
| used in sesame.
| Please make sure you have updated ExperimentHub and try
| > sesameDataCache("KYCG.MM285.TFBSconsensus.20220116")
| or download all data
| > sesameDataCache()
| to retrieve and cache needed sesame data.
Calls: getDBs ... capture.output -> withVisible -> .sesameDataGet -> stopAndCache
Perhaps the example should run sesameDataCache("KYCG.MM285.TFBSconsensus.20220116")
instead of
producing an error.
Note. The examples should be self-runnable otherwise they will produce an error on the Bioconductor Build System (BBS) as well.
Received a valid push on git.bioconductor.org; starting a build for commit id: dd12f8af59dc775c7652251ab3212c0b7a0070b8
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 22.04.3 LTS): knowYourCG_0.99.92.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/knowYourCG
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Hi @golddc
Thanks for making the update. Unfortunately, I see the same error with a different dataset.
> sesameData::sesameDataCache(data_titles=
+ c("KYCG.MM285.TFBSconsensus.20220116","KYCG.MM285.chromHMM.20210210"))
Metadata (N=1):
(1/1) EH6823:
> cg_lists <- getDBs("MM285.TFBS")
Selected the following database groups:
1. KYCG.MM285.TFBSconsensus.20220116
> queries <- cg_lists[(sapply(cg_lists, length) > 40000)]
> result_list <- lapply(queries, testEnrichment, "MM285.chromHMM")
Platform set to: MM285
Selected the following database groups:
1. KYCG.MM285.chromHMM.20210210
Testing against 18 database(s)...
Error in stopAndCache(title) :
| File MM285.address either not found or needs to be cached to be
| used in sesame.
| Please make sure you have updated ExperimentHub and try
| > sesameDataCache("MM285.address")
| or download all data
| > sesameDataCache()
| to retrieve and cache needed sesame data.
Calls: lapply ... capture.output -> withVisible -> .sesameDataGet -> stopAndCache
Execution halted
Can you try clearing your cache so that you can see the errors? -Marcel
Received a valid push on git.bioconductor.org; starting a build for commit id: 1e571aa71bc9841656cf730ee6f3931166a4681f
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 22.04.3 LTS): knowYourCG_0.99.93.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/knowYourCG
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Hi Marcel,
Thank you for pointing that out. I still had data sets cached so wasn’t seeing the same errors. I cleared the cache and went through the examples adding code to cache the files again. Everything should run fine. Please let me know if the package is ok now and if anything else comes to your attention. Thank you.
David
From: Marcel Ramos @.> Reply-To: Bioconductor/Contributions @.> Date: Wednesday, March 27, 2024 at 1:31 PM To: Bioconductor/Contributions @.> Cc: "Goldberg, David (NGG)" @.>, Mention @.***> Subject: [External] Re: [Bioconductor/Contributions] knowYourCG (Issue #3197)
Hi @golddchttps://github.com/golddc
Thanks for making the update. Unfortunately, I see the same error with a different dataset.
sesameData::sesameDataCache(data_titles=
Metadata (N=1):
(1/1) EH6823:
cg_lists <- getDBs("MM285.TFBS")
Selected the following database groups:
queries <- cg_lists[(sapply(cg_lists, length) > 40000)]
result_list <- lapply(queries, testEnrichment, "MM285.chromHMM")
Platform set to: MM285
Selected the following database groups:
Testing against 18 database(s)...
Error in stopAndCache(title) :
| File MM285.address either not found or needs to be cached to be
| used in sesame.
| Please make sure you have updated ExperimentHub and try
| > sesameDataCache("MM285.address")
| or download all data
| > sesameDataCache()
| to retrieve and cache needed sesame data.
Calls: lapply ... capture.output -> withVisible -> .sesameDataGet -> stopAndCache
Execution halted
Can you try clearing your cache so that you can see the errors? -Marcel
— Reply to this email directly, view it on GitHubhttps://github.com/Bioconductor/Contributions/issues/3197#issuecomment-2023378345, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AVO7FPZLQ2NWUZQUSLV4ZU3Y2L67RAVCNFSM6AAAAAA5NFIBD2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAMRTGM3TQMZUGU. You are receiving this because you were mentioned.Message ID: @.***>
Update the following URL to point to the GitHub repository of the package you wish to submit to Bioconductor
Repository: https://github.com/zhou-lab/knowYourCG 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.