EWCE - Githubissues

Al-Murphy commented 3 years ago

Update the following URL to point to the GitHub repository of the package you wish to submit to Bioconductor

Repository: https://github.com/neurogenomics/ewceData

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 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 help with submitting your package, please subscribe and post questions to the bioc-devel mailing list.

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 7726b72918dced307b5ee6ccb49bcc1064bcbcc7

bioc-issue-bot commented 3 years ago

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, 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/EWCE to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

Al-Murphy commented 3 years ago

Hi,

The latest build threw up some strange errors. Firstly, is there any way to extend the check time for the tests to avoid the timeout, the size of the datasets is necessary to hit all conditions in the package for the test coverage:

TIMEOUT: R CMD check exceeded 14 mins

Also there seems to be a Windows specific error

ERROR: dependencies 'RNOmni', 'HGNChelper' are not available for package 'EWCE'

lshep commented 3 years ago

I'll check on the windows packages not being available. They look like they have windows binaries so I'm surprised they are not installing. I'll let you know when I know more about the windows build.

No we do not extend the time limits for packages. Keep in mind we build and check every Bioconductor package nightly so we need to have some limits in place for resources. We do respect and encourage test coverage for package functionality. Might I suggest looking at implementing long tests. You would want to keep some testing of main functionality in daily testing but could do more extensive testing with the long tests that are run once a week with a more lenient time.

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 151e51fa9033ae884d49044f183212112139f751

bioc-issue-bot commented 3 years ago

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, TIMEOUT, 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/EWCE to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

Al-Murphy commented 3 years ago

Hi @lshep,

That makes sense with the nightly build, thanks for clarifying. Looking at the documentation page you sent, it specifies tests can run for an accumulated 40 minutes however, my tests don't run for near that long, has that limit changed? In fact when I run R CMD Check locally the tests complete in 8 minutes and the full check takes 24 minutes (see image below) which is a lot shorter than the time taken in the build report when it timed out. Is the 40 minutes for the full R CMD check? And is this error just not be reproducible locally and is there some reason running the check locally takes far less time than in the build report?

vjcitn commented 3 years ago

@hpages do BBS timings arise in the context of multi-package contention for resources? Can the user estimate BBS check times independently?

lshep commented 3 years ago

Sorry for the confusion. The single package builder does not use 40 minutes as the timeout limit. That is for the daily builders. For new package submissions the timeout limit is 15 minutes as we do not want every package submitted to utilize the max time. Those timeout limits are for the entire R CMD check to run.

Al-Murphy commented 3 years ago

So the 15 minutes is for the full R cmd check run? As in what's currently taking 24 minutes?

lshep commented 3 years ago

Correct. And reflected in the messages in the build report that it exceeds 15 minutes http://bioconductor.org/spb_reports/EWCE_buildreport_20210319063159.html

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 8a5fcad653e0ee7bd59ca78dce6677f1cb54e7c8

bioc-issue-bot commented 3 years ago

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/ewceData to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: ff4ce30373b53ea3ce9c2f67c6ea454c9bb9c231

bioc-issue-bot commented 3 years ago

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, 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/ewceData to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: fa1669e9b827d4407d707faa7c09a63395afb1a7

bioc-issue-bot commented 3 years ago

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/ewceData to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 18477a70ffa1aef9743576f861bcaa57c9d9c2f4

bioc-issue-bot commented 3 years ago

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/ewceData to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 143332bbc38f14d9f61b26b25b1b6a369f5c2aa4

bioc-issue-bot commented 3 years ago

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/ewceData to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 56d1be2b738f8721728422752aba3507f26334a4

bioc-issue-bot commented 3 years ago

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/ewceData to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: fb653cf08da967e075739a935b416dbca6e654ff

bioc-issue-bot commented 3 years ago

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, 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/EWCE to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

Al-Murphy commented 3 years ago

Hi @lshep,

There still seems to be a Windows specific issue running EWCE: the run fails to load a ExperimentHub dataset in the vignette tt_alzh <- tt_alzh() which corresponds to the function:

eh <- get_ExperimentHub()
eh[["EH5373"]]

Did anything come to light when looking into this previously? Other than this the only issue is a warning for R CMD Check taking longer than 10 minutes, I assume this is okay given you mentioned a 15 minute limit?

Thanks!

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: a50ea830d449c5a8933a6152fd1886d4882bd698

bioc-issue-bot commented 3 years ago

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, 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/EWCE to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 98d4d8072610e3631b139f8a5067c3081b2246c6

bioc-issue-bot commented 3 years ago

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, 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/EWCE to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

hpages commented 3 years ago

@Al-Murphy Maybe one thing that would help here is that you force creation of a permanent ExperimentHub cache so the data doesn't need to be re-downloaded each time the SPB runs R CMD build or R CMD check on the package. Once all the data makes it to the local cache, any subsequent build will be more reliable and faster.

@lshep What's the proper way to do this? By specifying ask=FALSE in the call to ExperimentHub()? I don't see any mention of the ask argument in ExperimentHub()'s man page.

lshep commented 3 years ago

@hpages Yes. As discussed with the Bioc team last week, we will be altering the caching behavior so when in a non-interactive session it will start creating the permanent location automatically instead of a tmp which will help on our servers as well as other institutional servers. I'm in process of fixing this behavior but was out of office last week. I'm hoping to have it implemented in Bioc devel by the end of this week. Yes the ask=FALSE would force create in the meantime, we didn't like to heavily advertise this as it forces the install location for a user even in a non-interactive session but it would force create the cache. When I update for the caching change, I'll make sure this is all better documented.

Al-Murphy commented 3 years ago

Thanks @lshep. Should I wait then for the change to be made at the end of the week (if you wouldn't mind commenting here when that happens if so) or will I change ask=FALSE to be able to make the change immediately (and possibly readdress later)?

lshep commented 3 years ago

Hold off on adding the force for now (It will actually be a good testing case for our builders to know we have one in the queue that should create it). I'll try to get to reviewing your packages by the end of the week or early next too so there can be other revisions if necessary. Cheers

lshep commented 3 years ago

Please see an initial review of EWCEdata and EWCE packages.

ewceData

DESCRIPTION

[ ] We recommend having LazyDatat: true removed from DESCRIPTION. We have rarely found useful and can slow package installation.

inst

[ ] Please include an inst/script directory that has a file describing how the object that was placed in experiment hub was created. Include source information and any preprocessing; it can be code, sudo-code, or text.

vignette

[ ] We recommend having a table of contents. I think this should be an option with toc: true
[ ] In vignette, man, and tests you download a file from google drive it seems? Can this file be included in the package if it is different than your files in the hub or included in the hub. We generally do not allow personal drives for storing data as it cannot be tracked and monitored.
[ ] What is the distinction between the data you are downloading from the txt file vs what is stored in the hubs? What is the relation?
[ ] You don't show any extraction of data from the hubs.

R

[ ] We like to see interoperability with Bioconductor objects and classes. Any Rectangular feature x sample data should be in SummarizedExperiment format as this is what is traditionally used in Bioconductor. The results of load.linnarsson.sct.data seem appropriate to be in SummarizedExpeirment format. I'm not sure if this also means updating the data provided in the hubs as well?
[ ] Functions should not contain . as it indicates a S3 disbatch. Please use camelcase or underscores.

General

[ ] Any file download should not download to a working directory but to a temporary directory with tempdir()

ewce

General

[ ] Please remove the _pkgdown.yml, Dockerfile and docker_push from the main branch pushed to git.bioconductor.org. While we recognize these are useful tools we are trying not to have external configurations on our system in case we implement anything of our own that could conflict. We recommend moving them to a different branch

DESCRIPTION

[ ] Please remove LazyData: true we have rarely found it useful and can actually slow package installation.

NAMESPACE

[ ] Please use camelcase or underscores for naming functions. The dot . indicates S3 disbatch and should be avoided.

README

[ ] Please include Bioconductor installations instructions

NEWS

[ ] News file is formatted improperly. Please see ?news in R or news guidelines. In particular regarding heading sections that should take the format Changes in version x.y.z

inst

[ ] Please also include an inst/scripts directory that describes how the data in inst/extdata was created. It can be code, sudo-code, or text but should include any source/version information and any preprocessing of files before including in the directory for release to users.
[ ] Are these really extdata objects? Perhaps they better belong in a doc or some other inst directory as extdata generally implies data objects to be loaded or referenced.

vignettes

[ ] We recommend having a table of contents. I think this should be an option with toc: true
[ ] Show Bioconductor installation instructions.
[ ] Again In vignette, you download a file from google drive it seems? If you need this file for examples it should also be part of the ecweData sets that are available via download from the hub. We do not allow personal drives for storing data as it cannot be tracked and monitored. It seems like this file should also be included in the hubs.
[ ] Any recommended downloaded file should be cached. The MRK_List2 for instance should probably have a designated download function where you do the caching in the backend if the files are not able to be included in the experimenthub data you already provide. It is possible to reference data from other hosted sites through experimenthub while not copying to S3 as long as the licensing allows such.
[ ] Files should be defaultly written to a tempdir() or using tempfile() currently while running your vignette there are files populating my home directory CellTypeData_ and a directory BootstrapPlots.
[ ]your functions should also take SummarizedExperiment objects the classic object for representing rectangular feature x sample data in Bioconductor. Given that your package is designed to work with single cell transcriptome data you might also look at the SingleCellExperiment class. It should be easy enough to check for the class in the function and extra the matrices if necessary for use with these objects.
[ ] We like to see interoperabiity with other standard Bioconductor objects as much as possible. There could be other areas that could show overlap like how to get gene lists and such with other Bioconductor packages. There are some Gene set classes that should be able to make wrappers to your functions to use. like BiocSet::BiocSet and GESABase::GeneSet

R/man

[ ] use message instead of print.

Please address the above issues in both packages and trigger rebuilds with version bumps. When you are ready for a re-review please comment here addressing and commenting on the above issues.

Cheers,

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: a734c6d1349a729a5c553bf312ac690010195e99

bioc-issue-bot commented 3 years ago

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/ewceData to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

Al-Murphy commented 3 years ago

Hi @lshep,

Thank you for the review notes. I have updated and submitted changes to ewceData. See below for how I resolved the issues you noted. I will deal with EWCE as a separate comment. Also not there was a fail on Windows, this is the same issue discussed with @hpages which I hope will be resolved with your work on altering the caching behaviour.

ewceData

DESCRIPTION

[x] We recommend having LazyDatat: true removed from DESCRIPTION. We have rarely found useful and can slow package installation. - I removed this.

inst

[x] Please include an inst/script directory that has a file describing how the object that was placed in experiment hub was created. Include source information and any preprocessing; it can be code, sudo-code, or text. - I have updated to include this.

vignette

[x] We recommend having a table of contents. I think this should be an option with toc: true - Added
[x] In vignette, man, and tests you download a file from google drive it seems? Can this file be included in the package if it is different than your files in the hub or included in the hub. We generally do not allow personal drives for storing data as it cannot be tracked and monitored. - I have removed these downloads along with the load.linnarsson.sct.data. The purpose of the function was to show how the data was formatted but I think it caused more confusion than what it was worth keeping it.
[x] What is the distinction between the data you are downloading from the txt file vs what is stored in the hubs? What is the relation? - They were the same, it was to show how to derive the data. This has been removed now.
[x] You don't show any extraction of data from the hubs. - Added to vignette

R

[x] We like to see interoperability with Bioconductor objects and classes. Any Rectangular feature x sample data should be in SummarizedExperiment format as this is what is traditionally used in Bioconductor. The results of load.linnarsson.sct.data seem appropriate to be in SummarizedExpeirment format. I'm not sure if this also means updating the data provided in the hubs as well? - Function has been removed so this shouldn't be necessary
[x] Functions should not contain . as it indicates a S3 disbatch. Please use camelcase or underscores. - Function removed so not necessary but I will bare it in mind for EWCE and any other packages I develop.

General

[x] Any file download should not download to a working directory but to a temporary directory with tempdir() - Removed so not necessary but again I'll keep it in mind

Al-Murphy commented 3 years ago

@lshep, I'm nearly through the changes for EWCE but one question I had about your point below:

Please remove the _pkgdown.yml, Dockerfile and docker_push from the main branch pushed to git.bioconductor.org. While we recognize these are useful tools we are trying not to have external configurations on our system in case we implement anything of our own that could conflict. We recommend moving them to a different branch

It was suggested in the Bioc-devel mailing list to just add _pkgdown.yml to the .Rbuildignore file. Would this be suitable? It would obviously be a very easy solution and would allow me to keep the pkgdown functionality which I really like for producing my vignette on a website easily.

Secondly, would this also be suitable for the two docker files? These are less important in my mind but again this would be beneficial

Thanks!

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 4eb4e6753be4833fb066c1a0d98c23dc1d9927e6

bioc-issue-bot commented 3 years ago

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, skipped". 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/ewceData to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 766fad9f0ab4fd58a5ec3194c0a3d8877a664a96

bioc-issue-bot commented 3 years ago

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, skipped". 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/EWCE to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

Al-Murphy commented 3 years ago

Hi @lshep, I have now made all the changes to EWCE and have pushed the new version. See below for my notes:

ewce

General

[x] Please remove the _pkgdown.yml, Dockerfile and docker_push from the main branch pushed to git.bioconductor.org. While we recognize these are useful tools we are trying not to have external configurations on our system in case we implement anything of our own that could conflict. We recommend moving them to a different branch - Done, I'm using a separate staging branch for these instead

DESCRIPTION

[x] Please remove LazyData: true we have rarely found it useful and can actually slow package installation. - Removed

NAMESPACE

[x] Please use camelcase or underscores for naming functions. The dot . indicates S3 disbatch and should be avoided. - Updated, I went with underscore approach for cohesion with other functions. README
[x] Please include Bioconductor installations instructions - Done in README and vignette

NEWS

[x] News file is formatted improperly. Please see ?news in R or news guidelines. In particular regarding heading sections that should take the format Changes in version x.y.z - Done, I have updated the format as described

inst

[x] Please also include an inst/scripts directory that describes how the data in inst/extdata was created. It can be code, sudo-code, or text but should include any source/version information and any preprocessing of files before including in the directory for release to users. - Added
[x] Are these really extdata objects? Perhaps they better belong in a doc or some other inst directory as extdata generally implies data objects to be loaded or referenced.- Created a new inst directory to hold these, they are not data objects

vignettes

[x] We recommend having a table of contents. I think this should be an option with toc: true - Added
[x] Show Bioconductor installation instructions. - Done
[x] Again In vignette, you download a file from google drive it seems? If you need this file for examples it should also be part of the ecweData sets that are available via download from the hub. We do not allow personal drives for storing data as it cannot be tracked and monitored. It seems like this file should also be included in the hubs. - I have removed this, I do this a few times as a means of showing how data available from ewceData was derived but I agree this is confusing so I have removed it. I have also added another data source to ewceData to make things more clear.
[x] Any recommended downloaded file should be cached. The MRK_List2 for instance should probably have a designated download function where you do the caching in the backend if the files are not able to be included in the experimenthub data you already provide. It is possible to reference data from other hosted sites through experimenthub while not copying to S3 as long as the licensing allows such. - This download has been removed so not necessary to cache
[x] Files should be defaultly written to a tempdir() or using tempfile() currently while running your vignette there are files populating my home directory CellTypeData_ and a directory BootstrapPlots. - I have updated these to a temp directory
[x] your functions should also take SummarizedExperiment objects the classic object for representing rectangular feature x sample data in Bioconductor. Given that your package is designed to work with single cell transcriptome data you might also look at the SingleCellExperiment class. It should be easy enough to check for the class in the function and extra the matrices if necessary for use with these objects. - I have updated the relevant functions to accept GRange SummarisedExperiment and SingleCellExperiment objects. Using these is also now discussed in the vignette.
[x] We like to see interoperabiity with other standard Bioconductor objects as much as possible. There could be other areas that could show overlap like how to get gene lists and such with other Bioconductor packages. There are some Gene set classes that should be able to make wrappers to your functions to use. like BiocSet::BiocSet and GESABase::GeneSet - I have added to the vignette describing how these objects can be used in EWCE

R/man

[x] use message instead of print. - Done

Separately, is there any update on the Cache approach for ExperimentHub? I noted that my latest ewceData and EWCE build had more errors than usual which seem related?

Thanks, Alan.

Al-Murphy commented 3 years ago

Hi @lshep, @hpages, has there been any update on the changes to the ExperimentHub package in regards to caching? Am I right to still assume this is what's causing the errors on my builds? Is there anything I can be doing to improve the package in light of the upcoming submission deadline?

Thanks, Alan.

lshep commented 3 years ago

@Al-Murphy I've been doing some follow up tests but yes it does appear the caching is now active for the SPB. If you would like to try and kick off a new build of the package by bumping the version. It might take too builds, one to do the caching, and one to run the code using the cached file instead of downloading.

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 347e524b6475f8e3d413138a30314441b814c01b

bioc-issue-bot commented 3 years ago

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/ewceData to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 3 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 0fa993a5e702f4e90cc87aa4f46115aa960a405c

bioc-issue-bot commented 3 years ago

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/ewceData to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

Bioconductor / Contributions

EWCE #1904