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

broadSeq resubmission #3381

Open
10 tasks done
vondoRishi opened this issue Mar 27, 2024 · 15 comments
Open
10 tasks done

broadSeq resubmission #3381

vondoRishi opened this issue Mar 27, 2024 · 15 comments
Assignees
Labels
2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place OK

Comments

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

  • I understand that by submitting my package to Bioconductor,
    the package source and all review commentary are visible to the
    general public.

  • I have read the Bioconductor Package Submission
    instructions. My package is consistent with the Bioconductor
    Package Guidelines.

  • I understand Bioconductor Package Naming Policy and acknowledge
    Bioconductor may retain use of package name.

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

  • My package addresses statistical or bioinformatic issues related
    to the analysis and comprehension of high throughput genomic data.

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

  • 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:

  • The 'devel' branch for new packages and features.
  • The stable 'release' branch, made available every six
    months, for bug fixes.
  • 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 @vondoRishi

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: broadSeq
Title: broadSeq : for streamlined exploration of RNA-seq data
Version: 0.99.0
Authors@R: 
    person("Rishi", "Das Roy", , "rishi.dasroy@gmail.com", role = c("aut", "cre"),
 comment = c(ORCID = "0000-0002-3276-7279"))
Description: This package helps user to do easily RNA-seq data analysis with multiple 
    methods (usually which needs many different input formats). Here the user will 
    provid the expression data as a SummarizedExperiment object and will get results 
    from different methods. It will help user to quickly evaluate different methods. 
License: MIT + file LICENSE
URL: https://github.com/dasroy/broadSeq
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
biocViews: GeneExpression, DifferentialExpression, RNASeq, 
        Transcriptomics
Suggests: 
    knitr,
    limma (>= 3.54.0),
    rmarkdown,
    stats (>= 4.2.2),
    samr
Depends: 
    dplyr,
    ggpubr,
    SummarizedExperiment 
Imports: 
    DELocal,
    EBSeq (>= 1.38.0),
    DESeq2 (>= 1.38.2),
    NOISeq,
    forcats (>= 1.0.0),
    genefilter,
    ggplot2,
    ggplotify,
    plyr,
    clusterProfiler (>= 4.8.2),
    pheatmap,
    sechm (>= 1.6.0),
    stringr,
    purrr (>= 0.3.5),
    edgeR (>= 3.40.1)
VignetteBuilder: knitr

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

lshep commented Apr 4, 2024

Please include an inst/scripts that has a file that describes how the data in inst/extdata was generated. It can be text, psuedo-code, or code but should contain any relevant source and licensing information.

@lshep lshep added pre-check passed pre-review performed and ready to be added to git Post Release Deadline package submitted after posted deadline. reviewer will only review if time allows 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): broadSeq_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/broadSeq to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@bioc-issue-bot
Copy link
Collaborator

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

@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): broadSeq_0.99.1.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/broadSeq 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 10, 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.

@vondoRishi
Copy link
Author

Looking forward to the reviewer's comments. :)

@lshep
Copy link
Contributor

lshep commented May 8, 2024

I'm so sorry for the long delay; I have been extremely backed up with post release tasks. I will have a review for you within the next day.

@lshep lshep removed the Post Release Deadline package submitted after posted deadline. reviewer will only review if time allows label May 9, 2024
@lshep
Copy link
Contributor

lshep commented May 9, 2024

README

  • Include Bioconductor installation instructions

man

  • Please have a package level man page so that if a naive user does
    ?broadSeq they are directed appropriately how to get started.

DESCRIPTION

  • When doing R CMD build the following occurs
  NB: this package now depends on R (>= 3.5.0)
  WARNING: Added dependency on R >= 3.5.0 because serialized objects in
  serialize/load version 3 cannot be read in older versions of R.
  File(s) containing such objects:
    'broadSeq/inst/extdata/rat_vole_mouseSE_salmon.rds'

We would appreciate a manual entry of R (>= 4.4.0) as this is the R value tested
against on our builders

BiocCheck

  • Plesae correct coding NOTES

general

  • We like to see endomorphism whenever possible. Curious your reasoning for
    taking in a SummarizedExperiment but then not returning it?

vignette
broadSeq.rmd

  • Could you please provide an abstract/intro section in your vignette that
    provides motivation for inclusion in Bioconductor and when appropriate a
    review and comparison to existing Bioconductor packages with similar
    functionality or scope.

  • This vignette shows no evaluated code. If I were a user I would not know
    where to start. Please include either references to the other vignettes or
    show/reference the main functions that can be used.

test

  • We really strongly encourage tests to ensure functions are working
    correctly

NEWS

  • We strongly advise a NEWS file. NEWS file not only make changes visible to
    end users, we collate the NEWS file for the Bioconductor relesae
    announcements. See example release announcement

@vondoRishi
Copy link
Author

Hi,

Are all of these comments mandatory?

@lshep
Copy link
Contributor

lshep commented May 20, 2024

For the most part yes. You could justify why something shouldn't be implemented and if reasonable I could potentially make an exception.

vondoRishi pushed a commit to dasroy/broadSeq that referenced this issue May 22, 2024
@bioc-issue-bot
Copy link
Collaborator

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

@vondoRishi
Copy link
Author

README

  • Include Bioconductor installation instructions

man

  • Please have a package level man page so that if a naive user does
    ?broadSeq they are directed appropriately how to get started.

DESCRIPTION

  • When doing R CMD build the following occurs

Fixed the serialized object

  NB: this package now depends on R (>= 3.5.0)
  WARNING: Added dependency on R >= 3.5.0 because serialized objects in
  serialize/load version 3 cannot be read in older versions of R.
  File(s) containing such objects:
    'broadSeq/inst/extdata/rat_vole_mouseSE_salmon.rds'

We would appreciate a manual entry of R (>= 4.4.0) as this is the R value tested against on our builders

BiocCheck

  • Plesae correct coding NOTES

There is no preprint or publication for this package yet

general

  • We like to see endomorphism whenever possible. Curious your reasoning for
    taking in a SummarizedExperiment but then not returning it?

There are many functions which return SummarizedExperiment object , like
broadSeq::transformDESeq2 or broadSeq::normalizeEdgerCPM

vignette broadSeq.rmd

  • Could you please provide an abstract/intro section in your vignette that
    provides motivation for inclusion in Bioconductor and when appropriate a
    review and comparison to existing Bioconductor packages with similar
    functionality or scope.
  • This vignette shows no evaluated code. If I were a user I would not know
    where to start. Please include either references to the other vignettes or
    show/reference the main functions that can be used.

test

  • We really strongly encourage tests to ensure functions are working
    correctly

At this moment, there is no manpower to write tests.

NEWS

  • We strongly advise a NEWS file. NEWS file not only make changes visible to
    end users, we collate the NEWS file for the Bioconductor relesae
    announcements. See example release announcement

In future releases, news will be included.

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

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 OK
Projects
None yet
Development

No branches or pull requests

3 participants