Bioconductor / Contributions

Contribute Packages to Bioconductor
131 stars 33 forks source link

saseR #3156

Closed alexandresegers closed 6 months ago

alexandresegers commented 9 months 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 9 months ago

Hi @alexandresegers

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: saseR
Type: Package
Title: Scalable Aberrant Splicing and Expression Retrieval
Date: 2023-06-01
Version: 0.99.0
Description: saseR is a highly performant and fast framework for aberrant expression and splicing analyses. The main functions are:
    \itemize{
    \item \code{\link{BamtoAspliCounts}} - Process BAM files to ASpli counts
    \item \code{\link{convertASpli}} - Get gene, bin or junction counts from ASpli SummarizedExperiment
    \item \code{\link{calculateOffsets}} - Create an offsets assays for aberrant expression or splicing analysis
    \item \code{\link{saseRfindEncodingDim}} - Estimate the optimal number of latent factors to include when estimating the mean expression
    \item \code{\link{saseRfit}} - Parameter estimation of the negative binomial distribution and compute p-values for aberrant expression and splicing
    }
    For information upon how to use these functions, check out our vignette at \url{https://github.com/statOmics/saseR/blob/main/vignettes/Vignette.Rmd} and the saseR paper: Segers, A. et al. (2023). Juggling offsets unlocks RNA-seq tools for fast scalable differential usage, aberrant splicing and expression analyses. bioRxiv. \url{https://doi.org/10.1101/2023.06.29.547014}.
Authors@R: c(person("Alexandre", "Segers", role = c("aut","cre"),
           email = "Alexandre.segers@ugent.be"),
         person("Jeroen","Gilis", role="ctb",
             email = "Jeroen.Gilis@ugent.be"),
         person("Mattias","Van Heetvelde", role="ctb",
             email = "Mattias.Vanheetvelde@ugent.be"),
         person("Elfride","De Baere", role="ctb",
             email = "Elfride.Debaere@ugent.be"),
         person("Lieven","Clement", role="ctb",
             email = "Lieven.Clement@ugent.be"))
Depends: R (>= 4.1)
Imports: ASpli,
     S4Vectors,
     BiocGenerics,
     GenomicFeatures,
     MASS,
     PRROC,
     SummarizedExperiment,
     edgeR,
     pracma,
     precrec,
     BiocParallel,
     DESeq2,
     DEXSeq,
     data.table,
     limma,
     havok,
     methods,
     GenomicRanges,
     GenomicAlignments,
     rrcov,
     MatrixGenerics,
     stats,
     IRanges,
     knitr,
     dplyr
VignetteBuilder: knitr
License: Artistic-2.0
URL: https://github.com/statOmics/saseR, https://doi.org/10.1101/2023.06.29.547014
Encoding: UTF-8
LazyData: FALSE
RoxygenNote: 7.2.3
biocViews:
    Regression,
    GeneExpression,
    AlternativeSplicing,
    RNASeq,
    Sequencing,
    Software
bioc-issue-bot commented 9 months 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 9 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: "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/saseR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

lshep commented 9 months ago

havok does not appear to be a CRAN or Bioconductor package? all package dependencies must be on CRAN or Bioconductor or they cannot be used as a dependency.

bioc-issue-bot commented 9 months ago

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

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

bioc-issue-bot commented 9 months ago

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

bioc-issue-bot commented 9 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, 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): saseR_0.99.2.tar.gz macOS 12.6.5 Monterey: saseR_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/saseR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

alexandresegers commented 9 months ago

Dear Reviewer,

I still obtain the BiocCheck error related to registration:

Nonetheless, both my GitHub account email and email in description (Alexandre.segers@ugent.be) are registered on this site. What else should I do to avoid this error?

Thank you in advance, Alexandre

lshep commented 9 months ago

We will ignore that error on our side as I can validate you are indeed registered. We will look into why that is not validating but it is an issue on our end. Please try to correct as many of the other Warnings and Notes as possible.

bioc-issue-bot commented 9 months ago

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

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

alexandresegers commented 9 months ago

Dear Reviewer,

I tried to correct the warning and notes that were left. However, these are the ones I did not resolve:

One of my functions is a small adaptation from ASpli. Therefore, I did not want to copy all the non-exported functions. The adaptation is however required as in the current implementation, parallelisation is not feasible, nor is using a dataset with all controls.

This is mainly due to the imported ASpli functions. I hope this is not of any problem.

* NOTE: The recommended function length is 50 lines or less. There
  are 11 functions greater than 50 lines.

I used a different coding style, and hope this is acceptable. the shorter lines are only ones from the description file which I do not manage to bring to 80 characters.

I look forward to any feedback. Best regards, Alexandre Segers

lshep commented 9 months ago

Please consider renaming your vignette. With something as generic as Vignette it can have naming conflicts depending on the order of packages loaded.

bioc-issue-bot commented 9 months ago

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

bioc-issue-bot commented 9 months ago

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

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

alexandresegers commented 8 months ago

Dear Reviewer,

Is there already some kind of feedback for our package submission?

Best regards, Alexandre Segers

DarioS commented 8 months ago

The package is in a high quality state. My main concern is that it uses ::: 18 times to use another package's private functions. Have you contacted developers of ASpli and asked them to make their functions exported? It seems like a lot of ways to break. It is also concerning that ASpli has a simple warning in development branch and a list of unanswered issues on GitHub. The warning stems from a poorly written NAMESPACE file which does not selectively import the functions which it needs, leading to a clash.

import(S4Vectors)
import(utils)

The main branch has not been updated since March 2021 which is coincidentally exactly when the software was published in a journal. So, it is effectively became neglected immediately after peer review finished. Also, issues raised by Bioconductor core team appear to be ignored. image

alexandresegers commented 8 months ago

Hey DarioS,

I have not contacted the developers of ASpli. However, because you mention that they are not responsive, I doubt that that will have an influence.

I could copy their functions and include them in the saseR package, while citing them properly. In the next update (as release is quite near...) I could further check if I can remove their functions completely.

Would that approach be fine for you?

Best regards, Alexandre Segers

lshep commented 7 months ago

@alexandresegers I'm not quite sure where the package stands. As far as ASpli, they had a maintainer change recently that may be more active/attentive. You could try reaching out.

bioc-issue-bot commented 7 months ago

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

bioc-issue-bot commented 7 months ago

Dear Package contributor,

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

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

On one or more platforms, the build results were: "WARNINGS, 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 Single Package Builder: Linux (Ubuntu 22.04.2 LTS): saseR_0.99.5.tar.gz macOS 12.7.1 Monterey: saseR_0.99.5.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/saseR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

alexandresegers commented 7 months ago

Dear Reviewer,

I have adapted the code such that no internal functions of ASpli are used. Instead, I have copied/adapted these functions, such that I can use them for my application, as the exported functions of ASpli require a design with at least 2 different groups, while this is not the case for my application. This way, I can also keep my package up to date when ASpli is not maintained.

I hope this solves the remainder of your comments. Best regards, Alexandre Segers

DarioS commented 7 months ago

One last task for you to complete.

alexandresegers commented 7 months ago

Dear Reviewer,

As mentioned before, I already registered, although the system does not recognise it.

Dear Reviewer,

I still obtain the BiocCheck error related to registration:

Nonetheless, both my GitHub account email and email in description (Alexandre.segers@ugent.be) are registered on this site. What else should I do to avoid this error?

Thank you in advance, Alexandre

Ishep responded the following.

We will ignore that error on our side as I can validate you are indeed registered. We will look into why that is not validating but it is an issue on our end. Please try to correct as many of the other Warnings and Notes as possible.

So I think this issue should be alright?

Best regards, Alexandre

lshep commented 7 months ago

@DarioS yes okay to ignore this for now; I have verified they are indeed registered and there is an issue with the validation api that still hope to fix this week (if not today)

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

lshep commented 6 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/alexandresegers.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("saseR"). The package 'landing page' will be created at

https://bioconductor.org/packages/saseR

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.