Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

pathlinkR #3179

Closed travis-m-blimkie closed 10 months ago

travis-m-blimkie 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 @travis-m-blimkie

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: pathlinkR
Type: Package
Title: Analyze and interpret RNA-Seq results
Version: 0.99.360
Authors@R: c(
    person("Travis", "Blimkie", , "travis.m.blimkie@gmail.com", role = c("cre"), comment = c(ORCID = "0000-0001-8778-8627")),
    person("Andy", "An", , "andy@hancocklab.com", role = c("aut"))
    )
Description: pathlinkR is an R package designed to facilitate analysis of 
    RNA-Seq results. Specifically, our aim with pathlinkR was to provide a 
    number of tools which take a list of DE genes and perform different analyses
    on them, aiding with the interpretation of results. Functions are included 
    to perform pathway enrichment, with muliplte databases supported, and tools
    for visualizing these results. Genes can also be used to create and plot 
    protein-protein interaction networks, all from inside of R. 
biocViews: GeneSetEnrichment, Network, Pathways, Reactome, RNASeq, 
    NetworkEnrichment
BiocType: Software
BugReports: https://github.com/hancockinformatics/pathlinkR
License: GPL-3 + file LICENSE
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
Imports:
    circlize,
    clusterProfiler,
    ComplexHeatmap,
    dplyr,
    ggforce,
    ggplot2,
    ggpubr,
    ggraph,
    ggrepel,
    grid,
    igraph,
    purrr,
    sigora,
    SteinerNet,
    stringr,
    tibble,
    tidygraph,
    tidyr,
    vegan,
    visNetwork
Depends: 
    R (>= 4.2.0)
LazyDataCompression: xz
LazyData: true
Suggests: 
    AnnotationDbi,
    BiocStyle,
    biomaRt,
    covr,
    jsonlite,
    knitr,
    org.Hs.eg.db,
    rmarkdown,
    scales,
    testthat (>= 3.0.0),
    vdiffr
VignetteBuilder: knitr
Config/testthat/edition: 3
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". 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): pathlinkR_0.99.360.tar.gz macOS 12.6.5 Monterey: pathlinkR_0.99.360.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/pathlinkR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

travis-m-blimkie commented 12 months ago

Hello,

I have worked on the package and made the changes need to fix the error identified in the build reports above, pushing everything to the Github "main" branch throughout. Because the issue involved the package being too large, I followed the instructions provided here and on the BFG page to clean the git history and get the package size below 5MB. However, I was unable to push these changes to the Bioconductor git repository (via these instructions). I tried pulling/merging from "upstream", and fixing the resulting conflicts, but now it says I'm ahead of "origin/main" by 133 commits, and I'm worried a push to Github may mess up the fixes I've done.

What's the recommended solution here? Is it possible to have the Bioconductor version of pathlinkR be updated from the current Github version? Maybe a fresh clone of the repository? That way all the changes I've made on Github won't be overwritten.

I'm new to this process, so if there's something I'm missing please let me know.

Cheers!

lshep commented 12 months ago

Yes we don't allow force pushes to the git.bicoonductor.org repo but we can reset it on our side from the github. I will try to get to this later today.

travis-m-blimkie commented 12 months ago

Perfect, thank you so much!

bioc-issue-bot commented 12 months ago

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

bioc-issue-bot commented 12 months 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: "WARNINGS". This may mean there is a problem with the package that you need to fix. Or it may mean that there is a problem with the build system itself.

Please see the build report for more details.

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

bioc-issue-bot commented 12 months ago

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

bioc-issue-bot commented 12 months 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): pathlinkR_0.99.370.tar.gz macOS 12.6.5 Monterey: pathlinkR_0.99.370.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/pathlinkR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 11 months ago

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

HelenaLC commented 11 months ago

First round of comments to get things started... Please respond back with what has/not been addressed, or if anything's unclear- happy coding.

For future reference: when first submitted to Bioconductor, a package should have pre-release version 0.99.0. I don't think this will be possible to implement now, as decreasing the version will not trigger a new built... but please checkout the info provided here regarding correct versioning of Bioc packages.

major:

minor:

DESCRIPTION

documentation

vignette

code

travis-m-blimkie commented 11 months ago

Thanks for the feedback and suggestions! I'll get to work on making changes, and come back with updates/questions.

travis-m-blimkie commented 11 months ago

I have made (nearly) all the changes as outlined in the "minor" section, and will start working on the "major" changes r.e. input classes.

For the warnings from devtools::test(), I've fixed what I can, but there are a few I don't think I can fix, outlined below. Open to suggestions for these:


Updated to-do list for the rest:

DESCRIPTION

Documentation

Vignette

Code

HelenaLC commented 11 months ago

Thanks for addressing (many) earlier comments - here a revised review of what's been addressed so far (last one being more of a comment/thinking out loud than critique):

travis-m-blimkie commented 11 months ago

Going back to your "major" comments r.e. input classes - I have tweaked the code so it can now accept "DESeqResults" (from DESeq2), or "TopTags" (from edgeR); in each case, column names for fold changes and p values are determined based on the class. Or, the input can be a simple "data.frame", with arguments to specify the requisite columns, allowing for greater flexibility of inputs.

I looked into the SummarizedExperiment class as you mentioned (primarily their vignette), but it seems that its intended for RNA-Seq count data, whereas the other classes ("DESeqResults" and "TopTags", which aren't derived from "SE") are tables of DE genes, which are "downstream" from said count data. From what I could find, the "SE" class is used only for earlier stages in the RNA-Seq analysis process than what we're targeting with pathlinkR. If I've missed something here please let me know, and if there are examples of DE gene tables stored as "SE" objects that'd be especially helpful.

Other minor points I've addressed:

HelenaLC commented 11 months ago

Agreed, if the whole package operates on downstream results only - supporting both DESeq(2) and edgeR, as well as arbitrary data.frames with corresponding results (as specified by optional function arguments) - then all is well in terms of interoperability, I think. Perhaps I am missing something, but did you merge/push these changes? I still do not see the flexibility you mentioned implemented (e.g., error: all(c("padj", "log2FoldChange") %in% colnames(deseqResult))).

travis-m-blimkie commented 11 months ago

I just pushed those updates now (along with a some other changes), if you want to take a look.

Regarding your comments on the data:

travis-m-blimkie commented 11 months ago

Following up on the previous comments:

All these changes have been pushed to the Github and Bioconductor repositories.

HelenaLC commented 11 months ago

Apologies for the delay, but I didn't get notified about a new build - so just to make sure, did you push with a version bump? Looking at your local branch, I don't see the DESCRIPTION changing versions, hence no build report/notification here on GH - but not sure if the recent release of Bioc 3.18 could have cause any issues (I don't think it should).

*Perhaps just to note that I do see the changes you made (appreciated!), and it's looking great. But at this point need a clean build and check before finalizing...

travis-m-blimkie commented 10 months ago

I hadn't pushed a version bump yet, figured I'd wait until most of the changes were settled first. But I will do that today and make sure everything is passing.

bioc-issue-bot commented 10 months ago

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

bioc-issue-bot commented 10 months 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: macOS 12.6.5 Monterey: pathlinkR_0.99.380.tar.gz Linux (Ubuntu 22.04.2 LTS): pathlinkR_0.99.380.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/pathlinkR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

HelenaLC commented 10 months ago

Thanks for all your efforts in addressing review comments! Appreciate especially the changes made towards more flexible handling of inputs towards interoperability!

bioc-issue-bot commented 10 months 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.

travis-m-blimkie commented 10 months ago

Of course, thanks for all your help and patience :) If there's anything else just let me know.

lshep commented 10 months ago

The default branch of your GitHub repository has been added to Bioconductor's git repository as branch devel.

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/travis-m-blimkie.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("pathlinkR"). The package 'landing page' will be created at

https://bioconductor.org/packages/pathlinkR

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.