Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

xcore #2496

Closed mcjmigdal closed 2 years ago

mcjmigdal commented 2 years ago

Confirm the following by editing each check box to '[x]'

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.

bioc-issue-bot commented 2 years ago

Hi @mcjmigdal

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: xcore
Title: xcore expression regulators inference
Version: 0.99.0
Authors@R:
    c(person(given = "Maciej",
 family = "Migdał",
 role = c("aut", "cre"),
 email = "mcjmigdal@gmail.com",
 comment = c(ORCID = "0000-0002-8021-7263")),
      person(given = "Bogumił",
 family = "Kaczkowski",
 role = c("aut"),
 email = "mcjmigdal@gmail.com",
 comment = c(ORCID = "0000-0001-6554-5608"))
     )
Description: xcore is an R package for transcription factor activity modeling
  based on known molecular signatures and user's gene expression data.
  Accompanying xcoredata package provides a collection of molecular signatures,
  constructed from publicly available ChiP-seq experiments.
License: GPL-2
Encoding: UTF-8
LazyData: false
LazyDataCompression: bzip2
Depends:
    R (>= 4.1)
Imports:
    DelayedArray (>= 0.18.0),
    edgeR (>= 3.34.1),
    foreach (>= 1.5.1),
    GenomicRanges (>= 1.44.0),
    glmnet (>= 4.1.2),
    IRanges (>= 2.26.0),
    iterators (>= 1.0.13),
    magrittr (>= 2.0.1),
    Matrix (>= 1.3.4),
    methods (>= 4.1.1),
    MultiAssayExperiment (>= 1.18.0),
    stats,
    S4Vectors (>= 0.30.0),
    utils
Suggests:
    BiocGenerics (>= 0.38.0),
    data.table (>= 1.14.0),
    devtools (>= 2.4.2),
    digest (>= 0.6.28),
    doMC (>= 1.3.7),
    KernSmooth (>= 2.23.20),
    knitr (>= 1.36),
    pheatmap (>= 1.0.12),
    proxy (>= 0.4.26),
    ridge (>= 3.0),
    rmarkdown (>= 2.11),
    rtracklayer (>= 1.52.0),
    testthat (>= 3.0.0),
    usethis (>= 2.0.1),
    xcoredata (>= 0.0.0.9000)
VignetteBuilder: knitr
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.1.2
Config/testthat/edition: 3
biocViews: GeneExpression, GeneRegulation, Epigenetics, Regression, Sequencing
vjcitn commented 2 years ago
* creating vignettes ... ERROR
--- re-building ‘xcore_vignette.Rmd’ using rmarkdown
Quitting from lines 30-31 (xcore_vignette.Rmd) 
Error: processing vignette 'xcore_vignette.Rmd' failed with diagnostics:
object 'rinderpest_mini' not found

You have rinderpest_mini.R in a data-raw folder. Please verify that your package can pass R CMD check, recommit to your github repo, and comment here for me to reevaluate.

mcjmigdal commented 2 years ago

AdditionalPackage: https://github.com/mcjmigdal/xcoredata

bioc-issue-bot commented 2 years ago

Can't build unless issue is open and '2. review in progress' label is present, or issue is closed and 'TESTING' label is present.

mcjmigdal commented 2 years ago

@vjcitn I've fixed the 'rinderpest_mini' issue, however I want to supplement xcore with an xcoredata data package. For development I was using github LFS, but now I am trying to move to Bioconductor's ExperimentHub. I've tried to reach out to hubs@bioconductor.org, but they did not respond to me since last week. Unfortunately, further down the vignette I am using one of the files from xcoredata which effectively means vignette build will ERROR. I will continue my efforts to move to Bioconductor's ExperimentHub. I will let you know once this is done, sorry for the confusion.

lshep commented 2 years ago

I'm sorry the email did not get through from hubs@bioconductor.org --- can you please email me directly and I can assist with the ExperimentHub lori.shepherd@roswellpark.org

mcjmigdal commented 2 years ago

@vjcitn hi I am back. Both xcore and additional package xcoredata are passing R's check and BiocCheck on my local enviroment. I am looking forward to see how it goes on your servers. Please kindly reevaluate my submission. Cheers MM

mcjmigdal commented 2 years ago

Hi @vjcitn What's the status? Cheers mm

vjcitn commented 2 years ago

devtools::load_all() should not be at the top of the vignette. it makes it hard for me to do the preliminary evaluation. please take it out.

mcjmigdal commented 2 years ago

@vjcitn should be fixed, let me know if I should bump package version

lshep commented 2 years ago

bare with us for a few minutes. Since you submitted the software first in order to assign the reviewer I have to process that package first. The build for that will initially fail because the data package is missing but once the issue is active I can process the data package next -- and then rerun the software once manually for you -- after that both packages will be linked to this issue and you can rebuild either by doing the valid version bump from there -- I hope this makes sense.

bioc-issue-bot commented 2 years ago

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

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

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

lshep commented 2 years ago

I'm rerunning the software package now with the data package available. You should be able to make changes to both packages and get new builds with version bumps committed to git.bioconductor.org.

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

mcjmigdal commented 2 years ago

@lshep thank you!

lshep commented 2 years ago

Please correct any TIMEOUT/ERROR/Warning/Notes from build reports before a more in-depth review will continue. Thank you

bioc-issue-bot commented 2 years ago

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

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

vjcitn commented 2 years ago

MacOS:

  > test_check("xcore")
  model.frame(formula = mpg ~ ., data = mtcars)
  [ FAIL 2 | WARN 0 | SKIP 0 | PASS 61 ]

   Failed tests 
   Failure (test_processing.R:107:3): addSignatures 
  digest::digest(mae) (`actual`) not equal to "b1493e0edf55d3347b328d6928ab15fb" (`expected`).

  `actual`:   "1d7c13819efc13aeab88f34d06dfc5a3"
  `expected`: "b1493e0edf55d3347b328d6928ab15fb"
   Failure (test_stats.R:269:3): modelGeneExpression 
  digest::digest(res) (`actual`) not equal to "d650ad7e3f963bbf4d9e29b4457aa392" (`expected`).

  `actual`:   "98d93ead7e362572773d4a6ed7dae6cf"
  `expected`: "d650ad7e3f963bbf4d9e29b4457aa392"

  [ FAIL 2 | WARN 0 | SKIP 0 | PASS 61 ]
  Error: Test failures
  Execution halted

Do you know why this is happening?

vjcitn commented 2 years ago

You won't find doMC on windows so you can't use it there. Please have a look at BiocParallel. You will be asked to use it unless there are overwhelming counterindications. On windows a snow-based parallelism is supported.

mcjmigdal commented 2 years ago

@vjcitn thank you for the comments, I will try to switch to BiocParallel. As for the other issue I am using digest hashes in my automatic test, in such a way that it tells only if outputs of the relevant function are valid. This approach however already showed short for me as these hashes seems to depend on R version and now apparently on the system as well. I will think of some other way to implement those tests.

vjcitn commented 2 years ago

I like the increased rigor of the testing. You should raise the issue on slack or bioc-devel. There may be some simpler approaches.

lshep commented 2 years ago

Please see long tests -- http://contributions.bioconductor.org/long-tests.html Some testing should be done daily and with regular testing but there could be more thorough and length tests implemented on long tests run once a week

bioc-issue-bot commented 2 years ago

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

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

mcjmigdal commented 2 years ago

@vjcitn hi, I've introduced the required changes including the use of BiocParallel. However, the package still fails to build under Windows...

The error is reported from the foreach loop:

Error: processing vignette 'xcore_vignette.Rmd' failed with diagnostics:
task 1 failed - "object 'runLinearRidge' not found"

here runLinearRidge is a internal function defined in xcore package.

That makes me suspect that something might be wrong with "parallelization" under Windows. Here is how the parallel backend is initialized in the vignette:

doParallel::registerDoParallel(2L)
BiocParallel::register(BiocParallel::DoparParam(), default = TRUE)

Kindly, let me know if I did something wrong here.

mcjmigdal commented 2 years ago

@vjcitn it looks like this might be more of a problem with the foreach package that I am using for parallel computing

here are some relevant links: https://stackoverflow.com/questions/50113694/r-foreach-parallel-and-package-variables https://github.com/RevolutionAnalytics/foreach/issues/3

I will return when I learn more about this, I will also try asking on bioc-devel

vjcitn commented 2 years ago

you need to use BiocParallel -- and on windows understand that separate processes are spawned in the snow paradigm and that each process needs to be sure to get all the resources needed. So you may need to pack more activities of package attachment and data initialization in your client processes on windows than on multicore, where resources are shared.

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 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". 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/xcore to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

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

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

mcjmigdal commented 2 years ago

@vjcitn I believe all is working as intended now.

We had some small changes to README and vignette after the last successful build. These changes should not have much impact, the change in vignette adds eval=FALSE chunk showing how data can be loaded directly from xcoredata package, instead of ExperimentHub we wanted to have it as an option to work with R4.1. However, it seems I can not trigger new build anymore or maybe it is just taking longer than usual. Could you please look into that such that we are clear to proceed?

Cheers MM

bioc-issue-bot commented 2 years ago

Your package has been accepted. It will be added to the Bioconductor nightly builds.

Thank you for contributing to Bioconductor!

Reviewers for Bioconductor packages are volunteers from the Bioconductor community. If you are interested in becoming a Bioconductor package reviewer, please see Reviewers Expectations.

lshep commented 2 years ago

The master branch of your GitHub repository has been added to Bioconductor's git repository.

To use the git.bioconductor.org repository, we need an 'ssh' key to associate with your github user name. If your GitHub account already has ssh public keys (https://github.com/mcjmigdal.keys is not empty), then no further steps are required. Otherwise, do the following:

  1. Add an SSH key to your github account
  2. Submit your SSH key to Bioconductor

See further instructions at

https://bioconductor.org/developers/how-to/git/

for working with this repository. See especially

https://bioconductor.org/developers/how-to/git/new-package-workflow/ https://bioconductor.org/developers/how-to/git/sync-existing-repositories/

to keep your GitHub and Bioconductor repositories in sync.

Your package will be included in the next nigthly 'devel' build (check-out from git at about 6 pm Eastern; build completion around 2pm Eastern the next day) at

https://bioconductor.org/checkResults/

(Builds sometimes fail, so ensure that the date stamps on the main landing page are consistent with the addition of your package). Once the package builds successfully, you package will be available for download in the 'Devel' version of Bioconductor using BiocManager::install("xcore"). The package 'landing page' will be created at

https://bioconductor.org/packages/xcore

If you have any questions, please contact the bioc-devel mailing list (https://stat.ethz.ch/mailman/listinfo/bioc-devel); this issue will not be monitored further.

lshep commented 2 years ago

The master branch of your GitHub repository has been added to Bioconductor's git repository.

To use the git.bioconductor.org repository, we need an 'ssh' key to associate with your github user name. If your GitHub account already has ssh public keys (https://github.com/mcjmigdal.keys is not empty), then no further steps are required. Otherwise, do the following:

  1. Add an SSH key to your github account
  2. Submit your SSH key to Bioconductor

See further instructions at

https://bioconductor.org/developers/how-to/git/

for working with this repository. See especially

https://bioconductor.org/developers/how-to/git/new-package-workflow/ https://bioconductor.org/developers/how-to/git/sync-existing-repositories/

to keep your GitHub and Bioconductor repositories in sync.

Your package will be included in the next nigthly 'devel' build (check-out from git at about 6 pm Eastern; build completion around 2pm Eastern the next day) at

https://bioconductor.org/checkResults/

(Builds sometimes fail, so ensure that the date stamps on the main landing page are consistent with the addition of your package). Once the package builds successfully, you package will be available for download in the 'Devel' version of Bioconductor using BiocManager::install("xcoredata"). The package 'landing page' will be created at

https://bioconductor.org/packages/xcoredata

If you have any questions, please contact the bioc-devel mailing list (https://stat.ethz.ch/mailman/listinfo/bioc-devel); this issue will not be monitored further.