Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pathwrap #3372

Open
Elizaddh opened this issue Mar 23, 2024 · 12 comments
Open

pathwrap #3372

Elizaddh opened this issue Mar 23, 2024 · 12 comments
Assignees
Labels
2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place 3e. pending pre-review changes review has indicated blocking concern that needs attention OK

Comments

@Elizaddh
Copy link

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]'

  • [ 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 Bioconductor Package Naming Policy and acknowledge
    Bioconductor may retain use of package name.

  • [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 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
Copy link
Collaborator

Hi @Elizaddh

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: pathwrap
Title: Wrapper for Automated RNASeq Data analysis and pathway visualization
Version: 0.99.0
Authors@R: 
    person("Eliza", "Dhungel","", "elidhungel@gmail.com", 
    role = c("aut", "cre"),
    comment = c(ORCID = "0000-0002-7246-9452"))
Description:
    Pathwrap is a RNASeq analysis tool that provides a wrapper
    for the processing of RNASeq datasets from quality control of raw
    reads to the visualization of enriched pathways obtained from processing 
    the datasets. This tool runs all the essential steps of RNASeq processing
    from quality control, filtering out low quality reads, trimming adapters,
    sequence alignment, alignment count, differential analysis, enrichment 
    analysis and pathway visualization. It is the first tool that combines 
    all essential steps of RNASeq analysis till pathway visualization. It has
    the ability to continue the analysis if it is halted at any stage and 
    generate quality pictures and generate comprehensive analysis of the data.
    Results of metabolomics experiment generating quantitative compound 
    information can be integrated with RNAseq data analysis and pathway 
    visualization.
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
URL: https://github.com/Kannapolis-Bioinformatics/pathwrap
BugReports: https://github.com/Kannapolis-Bioinformatics/pathwrap/issues
RoxygenNote: 7.3.1
Imports:
    stats,
    utils,
    grDevices, 
    methods,
    DESeq2,
    EnhancedVolcano,
    edgeR,
    fastqcr,
    gage,
    GenomicFeatures,
    ggplot2,
    parallel,
    Rfastp,
    ShortRead,
    pathview,
    QuasR,
    tools,
    Rsamtools,
    Rhisat2,
    AnnotationDbi,
    stringr,
    S4Vectors,
    ComplexHeatmap,
    SummarizedExperiment,
    KEGGREST
Depends: 
    R (>= 4.3.0)
License: MIT + file LICENSE
biocViews: 
    Alignment,
    Pathways,
    QualityControl, 
    Sequencing, 
    RNASeq,
    ChIPSeq,
    GeneExpression, 
    Transcription,
    ExperimentalDesign,
    Metabolomics
Suggests:
    RUnit,
    BiocManager,
    BiocStyle, 
    knitr,
    rmarkdown,
    BiocGenerics
VignetteBuilder: knitr
VignetteEngine: knitr, rmarkdown

@bioc-issue-bot bioc-issue-bot added the 1. awaiting moderation submitted and waiting clearance to access resources label Mar 23, 2024
@lshep
Copy link
Contributor

lshep commented Mar 28, 2024

You should not be trying to install system requirements for a user. Anything
that is needed to should be assumed to be installed by the user. If a system
dependency is needed please include an INSTALL file for installation
instructions http://contributions.bioconductor.org/sysdep.html and make sure it
is listed in the DESCRIPTION file.

@lshep lshep added the 3e. pending pre-review changes review has indicated blocking concern that needs attention label Mar 28, 2024
@Elizaddh
Copy link
Author

Elizaddh commented Apr 2, 2024

Hi,
It looks like some scripts in the readme.md file were trying to install packages. I commented them out. My packages only prompts/messages user to install the required package when reference directory is not provided as an argument. I updated the DESCRIPTION file with reference and annotation packages for mouse in the Suggests section. Also I updated the code to include proper name of pathways for compound sets analysis without which there was a bug in the result table generation. Please let me know if any other things triggered this issue or other issues.
Thanks,

@lshep
Copy link
Contributor

lshep commented Apr 4, 2024

Is there a reason to change the user's options in mktxdbobj.R options(cache_size = NULL, synchronous = NULL) ; it is not advisable to change user options without their permission?

Why are you looking in the working directory for files when it seems like file paths are specified by the user in plotpathways.R?

@lshep lshep added pre-check passed pre-review performed and ready to be added to git and removed 3e. pending pre-review changes review has indicated blocking concern that needs attention labels Apr 4, 2024
@bioc-issue-bot
Copy link
Collaborator

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 bioc-issue-bot added pre-review on bioconductor git and access to on demand build but not assigned reviewer until build report clean and removed 1. awaiting moderation submitted and waiting clearance to access resources pre-check passed pre-review performed and ready to be added to git labels Apr 4, 2024
@bioc-issue-bot
Copy link
Collaborator

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on the Bioconductor Single Package Builder.

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 Single Package Builder:
Linux (Ubuntu 22.04.3 LTS): pathwrap_0.99.0.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/pathwrap to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@lshep lshep added 2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place and removed pre-review on bioconductor git and access to on demand build but not assigned reviewer until build report clean labels Apr 4, 2024
@bioc-issue-bot
Copy link
Collaborator

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

@vjcitn
Copy link
Collaborator

vjcitn commented Apr 12, 2024

Thanks for this submission. We've discussed it internally and have some concerns. First, the vignette includes (I substitute dots for backtick)

...r installation, eval = FALSE}
library(pathwrap)
data(anntpkglist, package = "pathwrap")
#replace Homo sapiens with scientific name of mouse, Mus musculus for mouse data
genomepkg <- anntpkglist$genome[which(anntpkglist$species == "Homo sapiens")]
anntpkg <- anntpkglist$annotate[which(anntpkglist$species == "Homo sapiens")]
#BiocManager::install(genomepkg)
#BiocManager::install(anntpkg)

So no code is being run or tested. This is not how vignettes are intended to work ... They really should put mileage on your code so that any bit-rot can be exposed when vignette computations fail. Is it possible to construct a modest working example with running code in the vignette? It might be more appropriate to submit this as a workflow package.

@vjcitn vjcitn added the 3e. pending pre-review changes review has indicated blocking concern that needs attention label Apr 12, 2024
@vjcitn
Copy link
Collaborator

vjcitn commented Apr 12, 2024

I am setting the flag to "pre-review" changes needed.

@Elizaddh
Copy link
Author

Hi,
Thank you for the comments and concerns. I plan to rewrite vignettes and get some test codes running moving forward. I will update the package soon in github and let you know.
Eliza.

@lshep
Copy link
Contributor

lshep commented May 17, 2024

Just wanted to check in to see if we may expect any updates soon?

@Elizaddh
Copy link
Author

Hi,
sorry for late response. I got occupied with other issues.I will probably work on this in July. Please expect an update after July 10 on early.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place 3e. pending pre-review changes review has indicated blocking concern that needs attention OK
Projects
None yet
Development

No branches or pull requests

5 participants