Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

DeProViR #3148

Closed mrbakhsh closed 9 months ago

mrbakhsh commented 1 year ago

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

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

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 1 year ago

Hi @mrbakhsh

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: DeProViR
Type: Package
Title: A Deep-Learning Framework Based on Pre-trained Sequence Embeddings for 
   Predicting Host-Viral Protein-Protein Interactions
Version: 0.99.0
Authors@R: c(
    person("Matineh", "Rahmatbakhsh", ,"matinerb.94@gmail.com",c("aut","trl","cre")))
Description: Emerging infectious diseases, exemplified by the zoonotic COVID-19 
   pandemic caused by SARS-CoV-2, are grave global threats. Understanding 
   protein-protein interactions (PPIs) between host and viral proteins is 
   essential for therapeutic targets and insights into pathogen replication and 
   immune evasion. While experimental methods like yeast two-hybrid screening and 
   mass spectrometry provide valuable insights, they are hindered by experimental 
   noise and costs, yielding incomplete interaction maps. Computational models, 
   notably DeProViR, predict PPIs from amino acid sequences, incorporating 
   semantic information with GloVe embeddings. DeProViR employs a Siamese 
   neural network, integrating convolutional and Bi-LSTM networks to enhance 
   accuracy. It overcomes the limitations of feature engineering, offering an 
   efficient means to predict host-virus interactions, which holds promise 
   for antiviral therapies and advancing our understanding of infectious diseases.
License: MIT+ file LICENSE
Encoding: UTF-8
URL: https://github.com/mrbakhsh/DeProViR
BugReports: https://github.com/mrbakhsh/DeProViR/issues
Depends: 
    keras
Imports: 
    caret,
    data.table,
    dplyr,
    fmsb,
    ggplot2,
    grDevices,
    pROC,
    PRROC,
    readr,
    stats
VignetteBuilder: knitr
Suggests:
   rmarkdown,
   tensorflow,
   reticulate,
   BiocStyle,
   RUnit,
   knitr,
   BiocGenerics
biocViews: 
    Proteomics,
    SystemsBiology,
    NetworkInference,
    NeuralNetwork,
    Network
RoxygenNote: 7.2.3
lshep commented 1 year ago

If https://nlp.stanford.edu/projects/glove/glove.6B.zip is needed, would it make sense to cache this file rather than redownload each time its needed?

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year ago

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, 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.

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

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year ago

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, 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.

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

mrbakhsh commented 1 year ago

Hi @lshep, Thank you very much for the suggestion, I have already cached a file using BiocFileCache and incorporated it into my code. However, I am not sure what the issue is with the build since, on my own platform, I am able to build the package successfully without any errors or warnings. I would greatly appreciate your help in resolving this.

lshep commented 1 year ago

My guess would be a timeout issue. As when I try to run the code I get a timeout reached. The default timeout for download.file is 60 seconds.

> zip_url <- "https://nlp.stanford.edu/data/glove.6B.zip"
>  dest_folder = tempdir()
> download.file(zip_url, destfile = file.path(dest_folder, "glove.6B.zip"),mode = "wb")
trying URL 'https://nlp.stanford.edu/data/glove.6B.zip'
Content type 'application/zip' length 862182613 bytes (822.2 MB)
===================
downloaded 315.9 MB

Error in download.file(zip_url, destfile = file.path(dest_folder, "glove.6B.zip"),  : 
  download from 'https://nlp.stanford.edu/data/glove.6B.zip' failed
In addition: Warning messages:
1: In download.file(zip_url, destfile = file.path(dest_folder, "glove.6B.zip"),  :
  downloaded length 0 != reported length 0
2: In download.file(zip_url, destfile = file.path(dest_folder, "glove.6B.zip"),  :
  URL 'https://downloads.cs.stanford.edu/nlp/data/glove.6B.zip': Timeout of 60 seconds was reached

You should make note of this is the documentation. Both man pages and vignette. You can set a timeout with options(timeout=120) . Before you run your function to download, add this with appropriate note that a user should increase this to a reasonable, expected time (in seconds) for the file download to complete.

> options(timeout=120)
> download.file(zip_url, destfile = file.path(dest_folder, "glove.6B.zip"),mode = "wb")
trying URL 'https://nlp.stanford.edu/data/glove.6B.zip'
Content type 'application/zip' length 862182613 bytes (822.2 MB)
=====================================
downloaded 620.2 MB

Error in download.file(zip_url, destfile = file.path(dest_folder, "glove.6B.zip"),  : 
  download from 'https://nlp.stanford.edu/data/glove.6B.zip' failed
In addition: Warning messages:
1: In download.file(zip_url, destfile = file.path(dest_folder, "glove.6B.zip"),  :
  downloaded length 0 != reported length 0
2: In download.file(zip_url, destfile = file.path(dest_folder, "glove.6B.zip"),  :
  URL 'https://downloads.cs.stanford.edu/nlp/data/glove.6B.zip': Timeout of 120 seconds was reached
bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year ago

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, 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.

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

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year ago

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, 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.

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

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year ago

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, 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.

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

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year ago

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, 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.

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

mrbakhsh commented 1 year ago

Hi @lshep, thank you once more for your suggestion. I included the timeout option in both the vignettes and the man files. However, I am getting a new error stating that 'con' is not recognized as a connection. I still can't reproduce this error on my own system, and the package continues to pass without any errors or warnings during the R CMD check and R CMD build.

lshep commented 1 year ago
> model_training <- ModelTraining(
+       url_path = "https://nlp.stanford.edu/data",
+       training_dir = system.file("extdata/training_Set",
+                               package = "DeProViR"),
+       input_dim = 20,
+       output_dim = 100,
+       filters_layer1CNN = 32,
+       kernel_size_layer1CNN = 16,
+       filters_layer2CNN = 64,
+       kernel_size_layer2CNN = 7,
+       pool_size = 30,
+       layer_lstm = 64,
+       units = 8,
+       metrics = "AUC",
+       cv_fold = 5,
+       epochs = 100,
+       batch_size = 128,
+       plots = FALSE,
+       tpath = tempdir(),
+       save_model_weights = FALSE,
+       filepath = tempdir()) 
Error in readLines(unzip(zipfile = bfcinfo(bfc["BFC1"])$rpath, files = "glove.6B.100d.txt",  : 
  'con' is not a connection
In addition: Warning message:
In unzip(zipfile = bfcinfo(bfc["BFC1"])$rpath, files = "glove.6B.100d.txt",  :
  error 1 in extracting from zip file
lshep commented 1 year ago

You also shouldn't assume that your resources is "BFC1" . If you are using the default cache which on quick glance seems true, a user could have cached something before your file. You will need to bfcquery to file the id that is associated with your package.

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year ago

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, 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.

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

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year ago

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: "TIMEOUT, 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.

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

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year ago

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, 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.

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

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year ago

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, 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.

The following are build products from R CMD build on the Bioconductor Build System: macOS 12.6.5 Monterey: DeProViR_0.99.10.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/DeProViR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year ago

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, 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.

The following are build products from R CMD build on the Bioconductor Build System: macOS 12.6.5 Monterey: DeProViR_0.99.11.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/DeProViR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

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

vjcitn commented 1 year ago

This is what I am seeing in a clean environment on ubuntu with all deps satisfied, rendering the vignette:

> render("DeProViR_tutorial.Rmd", html_document())

processing file: DeProViR_tutorial.Rmd
  |......................                              |  43% [unnamed-chunk-2]
Would you like to create a default python environment for the reticulate package? (Yes/no/cancel) yes
  |..............................                      |  57% [unnamed-chunk-3]
Would you like to create a default python environment for the reticulate package? (Yes/no/cancel) yes
  |.....................................               |  71% [unnamed-chunk-4]
Would you like to create a default python environment for the reticulate package? (Yes/no/cancel) yes
  |.............................................       |  86% [unnamed-chunk-5]
Would you like to create a default python environment for the reticulate package?

This makes no sense. Please use basilisk to manage your python usage.

bioc-issue-bot commented 1 year ago

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, 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.

The following are build products from R CMD build on the Bioconductor Build System: macOS 12.6.5 Monterey: DeProViR_0.99.12.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/DeProViR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year ago

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, 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.

The following are build products from R CMD build on the Bioconductor Build System: macOS 12.6.5 Monterey: DeProViR_0.99.13.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/DeProViR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

mrbakhsh commented 1 year ago

@lshep , thank you for the help; now the issue has been resolved. @vjcitn, thanks a lot for the suggestion. But, the package has been built successfully on the macOS environment. I did not use any specific Python modules here to use the basilisk. Before running the package on my system, I use reticulate::use_python("~/miniforge3/envs/tf-2.6/bin/python") to specify the Python path for running DL algorithms.

mrbakhsh commented 1 year ago

Hi @vjcitn and @lshep, can you please help me with resolving an error in the Linux environment? The package ran successfully on the macOS system. Essentially, I followed the same steps as the GenProSeq Bioconductor package.

lshep commented 1 year ago

It looks like there is an ERROR because the path is incorrect? should be test_Set not test_set. Linux is case sensitive (as is R code)

hpages commented 1 year ago

Also proper use of system.file() is:

system.file("extdata", "test_Set", "test_set_unknownInteraction.csv", package = "DeProViR")
bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year ago

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: "TIMEOUT, 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.

The following are build products from R CMD build on the Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): DeProViR_0.99.14.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/DeProViR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year ago

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): DeProViR_0.99.15.tar.gz macOS 12.6.5 Monterey: DeProViR_0.99.15.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/DeProViR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year ago

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): DeProViR_0.99.16.tar.gz macOS 12.6.5 Monterey: DeProViR_0.99.16.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/DeProViR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year ago

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): DeProViR_0.99.17.tar.gz macOS 12.6.5 Monterey: DeProViR_0.99.17.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/DeProViR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

mrbakhsh commented 1 year ago

Hi @lshep @hpages, thanks for the help; the package is now built with no error.

bioc-issue-bot commented 1 year ago

A reviewer has been assigned to your package for an indepth review. Please respond accordingly to any further comments from the reviewer.

hpages commented 1 year ago

Thanks for submitting DeProViR to Bioconductor.

Please name your functions consistently:

> ls('package:DeProViR')
[1] "encode_HostSeq"             "encode_ViralSeq"           
[3] "gloveEmb_import"            "Load_PreTrainedModel"      
[5] "load_TrainingSet"           "ModelPerformance_evalPlots"
[7] "ModelTraining"              "predInteractions"          

Some multipart names use the underscore (encode_ViralSeq), others don't (e.g. predInteractions). Casing is also inconsistent like in load_TrainingSet vs Load_PreTrainedModel. Please choose a style and stick to it. Bioconductor recommends the camelCase style for function names.

The man page for one of the 2 main functions in the package (ModelTraining()) has no example, and the code chunk in the vignette where the function is used is not evaluated. Plus the package has no unit tests. This means that the function is never evaluated during R CMD build or R CMD check. This in turn means that we have no way to automatically detect whether the ModelTraining() function is working as expected or not. Note that the reason Bioconductor insists on having all user-facing functions in a package used in the examples or vignette is to allow automated quality control on the package.

Use <- consistently everywhere for assignment. For example, in the example below (from ?ModelPerformance_evalPlots) you're sometimes using = and sometimes <-:

pred_label = seq(0,1, length.out = 100)
truth_label = rep(c(0,1), each = 50)
perf <- ModelPerformance_evalPlots(pred_label, truth_label,
tpath = tempdir())

Also please use proper indentation for multiple-line expressions, to make the code easier to read.

So the above code should look something like this:

pred_label <- seq(0,1, length.out = 100)
truth_label <- rep(c(0,1), each = 50)
perf <- ModelPerformance_evalPlots(pred_label,
                                   truth_label,
                                   tpath = tempdir())

Make sure to apply the same changes to all the examples and code in the package.

The Details sections in your man pages look like this:

Details:

     ModelPerformance_evalPlots

or

Details:

     predInteractions

or

Details:

     ModelTraining

etc... That is, they just repeat the name of the function! They should of course provide details about what the function does. However note that, for some of your functions, the Description section already provides some of the details. So either move the details to the Details section and keep the Description section short, or remove the Details section. What you choose to do exactly will depend on each function and the amount of details that you provide.

Thanks, H.

lshep commented 1 year ago

@mrbakhsh Do you plan on updating the package to follow the suggestions from @hpages ?