Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

BioNAR #2780

Closed lptolik closed 1 year ago

lptolik 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 @lptolik

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: BioNAR
Title: Biological Network Analysis in R
Version: 0.99.001
Authors@R: c(
    person("Colin", "Mclean", 
        email="Colin.D.Mclean@ed.ac.uk", role="aut"), 
    person("Anatoly", "Sorokin", 
        email="lptolik@gmail.com", role=c("aut", "cre")), 
    person("Oksana", "Sorokina", 
        email="oksana.sorokina@ed.ac.uk", role="aut"),
    person("J. Douglas", "Armstrong", 
        email="Douglas.Armstrong@ed.ac.uk", role = "aut") )
Description: the R package BioNAR, developed to step by step analysis of PPI 
  network. The aim is to quantify and rank each protein’s simultaneous 
  impact into multiple complexes based on network topology and 
  clustering. Package also enables estimating of co-occurrence of 
  diseases across the network and specific clusters pointing towards 
  shared/common mechanisms. 
License: Artistic-2.0
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.1
Depends: igraph, poweRlaw, org.Hs.eg.db, latex2exp, RSpectra, rSpectral, WGCNA, ggplot2, Rdpack
Imports: stringr, synaptome.db, clusterCons, fgsea, grid, methods, scales, AnnotationDbi
RdMacros: Rdpack
Suggests: 
    knitr, 
    rmarkdown,
    igraphdata,
    testthat (>= 3.0.0),
    devtools, ggrepel, pander, plotly, randomcoloR
Config/testthat/edition: 3
VignetteBuilder: knitr
biocViews: Software, GraphAndNetwork, Network
vjcitn commented 1 year ago

Vignette is taking a while to build, so I ran a purled version and saw

 head(mc)
     ID      DEG  BET         CC      SL       mnSP    PR         sdSP   
[1,] "273"   "12" "833.233"   "0.106" "44656"  "3.424" "0.000786" "0.707"
[2,] "6455"  "22" "5444.71"   "0.082" "170211" "2.955" "0.001337" "0.683"
[3,] "1759"  "16" "1744.932"  "0.217" "150771" "3.062" "0.000962" "0.687"
[4,] "1785"  "27" "10994.509" "0.071" "218717" "2.89"  "0.001644" "0.701"
[5,] "26052" "6"  "291.138"   "0.133" "55060"  "3.503" "0.000405" "0.743"
[6,] "2923"  "7"  "1225.709"  "0.095" "55104"  "3.391" "0.000531" "0.758"

those character representations of numeric (esp. floating point) data are not desirable. Can you intervene to ensure that the user gets entities of appropriate type? Looks like calcAllClustering is slow and perhaps you don't want to do this in the vignette. Maybe you can precompute and use a serialized result.

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

DarioS commented 1 year ago

While you are working on getting the code to build and check fine, please also update to meet the Developer's Guide rules.

  • Always use space after a comma. This: a, b, c.
  • Space around all binary operators: a == b. Use camelCase: initial lowercase, then alternate case between words.

Your variable naming usage is inconsistent e.g. intra_m, inter_m, intraEdgesM. Also, don't use uninformative variable names like i or gg. Use names such as sampleIndex instead for readability.

bioc-issue-bot commented 1 year ago

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

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 Linux, Mac, and Windows.

On one or more platforms, the build results were: "ERROR, 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/BioNAR 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: 26f46354887b201a99a306daaa90144ee11a60cf

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 Linux, Mac, and Windows.

On one or more platforms, the build results were: "ERROR, 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/BioNAR 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: 9388a8c650d6271b258949e5098a7ba9d29a0d0e

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 Linux, Mac, and Windows.

On one or more platforms, the build results were: "ERROR, 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/BioNAR 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: acdbfaab72c08936eb0f33a9eadee9dbbe01b2f7

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 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/BioNAR 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: 5acf59610c0e528db0ef0b5f1ffd90ef9575ab5a

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

DarioS commented 1 year ago

Thanks for fixing the errors and warnings. There are currently a number of issues which I have identified.

bioc-issue-bot commented 1 year ago

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

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

lptolik commented 1 year ago

Dear Dario,

Thank you for reviewing our package.

Could you, please clarify what do you mean when you propose to use Pairs for binary PPI edges as an integration with Bioconductor packages and classes?

We are already using synaptome.db, fgsea and I'm incorporating GO.db to replace the static annotation.

The central classes of the package are Graph, Node, and Edge from the igraph package. If you think that export of some data would simplify its reuse by others I can create accessor functions to export edges in the Pairs and nodes as Vector with Annotation metadata, but for the internal algorithms use of S4Vectors classes is excessive and unnecessary at the moment. We will consider its usage for the future.

Cheers, Anatoly on behalf of the package developers

DarioS commented 1 year ago

Ah, thanks for the clarification. It seems wise to stick with Graph, Node and Edge data container classes.

bioc-issue-bot commented 1 year ago

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

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 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/BioNAR 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: 7a17202290d0cce4f9fc710b49a2b42e28da39f9

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 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/BioNAR 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: f082dbff20c6f957ee4c5c0b15f5acdd447fe740

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 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/BioNAR 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: a39169966f5e68ae10554ff09ae8910b16acda5e

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

lptolik commented 1 year ago

Review’s Comments

We appreciate the reviewer’s comments regarding our package submission to BioConductor. We have gone through each of them, answering them as completely as possible, please see the responses below. We would be grateful if the review could now provide us with any additional comments, so that we can be in the position to complete these and finalise our package for submission to BioConductor for the 26th of October 2022 release date.

Comment (1):

While you are working on getting the code to build and check fine, please also update to meet the Developer's Guide rules.

Response (1):

We have changed all functions to the camelCase, added spaces, and applyed RStudio formatting to all our code.

Comment (2):

“_Your variable naming usage is inconsistent e.g. intra_m, interm, intraEdgesM. Also, don't use uninformative variable names like I or gg. Use names such as sampleIndex instead for readability.

Response (2):

We have tried to go back through and make the variable names as meaningful and consistent as possible. Most variable names we use already carry meaning; the review commented on ‘gg’, which actually stands for ‘gene-graph’, and in the context of the package carries a lot of meaning.

Comment (3):

Thanks for fixing the errors and warnings. There are currently a number of issues which I have identified.

Response (3):

Our package is designed around graphs, or networks, as the underlying data container. One of the fundamental and universal R packages to both represented and preform analysis with this type of data is called igraph. Although we acknowledge igraph is not part of BioConductor, we note other BioConductor packages also rely on igraph to store and represent its data, e.g. RedeR.

Comment (4):

Please don't use flatfile.go.BP.csv, flatfile.go.MF.csv, flatfile.go.CC.csv files. You are required to use AnnotationDbi to interact with GO.db to interface with existing Bioconductor infrastructure.

Response (4):

We have added the function ‘annotateGOont’ to our code to use GO.db to add GO annotations to graph nodes. However, we also feel it is important to provide the user functionality to load & save annotation flat files, as many labs manually created subsets of GO for their own analysis.

Comment (5):

See the developer's guide section about vignettes. There need to be installation instructions near the beginning. Introduction and Overview of Capabilities sections are currently empty. Use the Predefined Network has only code but no paragraphs of explanations about what it does and how the user should interpret the output. It's not clear what biological problem the package is trying to solve. The vignette is a disjointed collection of section headings with many one-sentence or empty explanations that lacks meaningful connection between consecutive sections. The introduction of the vignette doesn't explain what the data set used in all of the following samples is.

Response (5):

We have added an installation section to our package repo, instructing the use how to install our package. We have significantly edited vignette to include Introduction and detailed Overview of capabilities. We hope that Introduction now answers the question about biological problem. We have also edited and expanded the vignette sections to make the links between them, and explained the origin of the datasets.

Comment (6):

Things which should be a documented function in the package are instead lengthy code blocks in the vignette. For example, the plot.bridgeness chunk and plotly chunks ought to be converted into a function which the user could execute.

Response (6):

A new function called ‘plotBridgeness’ has been added to our code.

Comment (7):

“_Data sets need their own documentation. See Package Data in the developer's guide. The files PPI_Presynaptic.csv, flatfile_human_gene2HDO.csv, SCHflatfile.csv, PresynAn.csv, flatfile.go.BP.csv, flatfile.go.MF.csv, flatfile.go.CC.csv are not documented according to Bioconductor requirements.

Response (7):

Data sets were annotated as requested.

Comment (8):

The majority of your exported functions should have a unit test. Please see the Unit Tests section of the developer's guide. Currently, there is only one trivial unit test of get functions. Unit tests became a Bioconductor requirement a couple of years ago so, although many older packages don't have unit tests, all new ones are required to have comprehensive ones.

Response (8):

At the moment the test coverage is above 85%, which covers all exported functions.

DarioS commented 1 year ago

Thanks for the updates. I think that the package is now ready for acceptance.

Note that unit tests are equally important for non-exported functions as they are for exported functions. Their purpose is to test that calculations are correct and that their outputs don't change over time.

bioc-issue-bot commented 1 year 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 1 year 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/lptolik.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("BioNAR"). The package 'landing page' will be created at

https://bioconductor.org/packages/BioNAR

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.