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

MatrixGenerics #1448

Closed
8 tasks done
PeteHaitch opened this issue Mar 31, 2020 · 12 comments
Closed
8 tasks done

MatrixGenerics #1448

PeteHaitch opened this issue Mar 31, 2020 · 12 comments
Assignees
Labels
3a. accepted will be ingested into Bioconductor daily builder for distribution ERROR

Comments

@PeteHaitch
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 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 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 help with submitting your package, please subscribe and post questions
to the bioc-devel mailing list.

@bioc-issue-bot
Copy link
Collaborator

Hi @PeteHaitch

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: MatrixGenerics
Title: S4 Generic Summary Statistic Functions that Operate on Matrix-Like Objects
Description: S4 generic functions modeled after the 'matrixStats' API
    for alternative matrix implementations. Packages with alternative matrix
    implementation can depend on this package and implement the generic 
    functions that are defined here for a useful set of row and column
    summary statistics. Other package developers can import this package
    and handle a different matrix implementations without worrying
    about incompatibilities.
Version: 0.99.0
Authors@R: c(person("Constantin", "Ahlmann-Eltze", email = "artjom31415@googlemail.com", 
        role = c("aut"), comment = c(ORCID = "0000-0002-3762-068X")),
   person("Peter", "Hickey", role = c("aut", "cre"),
          email = "peter.hickey@gmail.com"))
Imports: methods
Depends: matrixStats (>= 0.56.0)
License: Artistic-2.0
Encoding: UTF-8
URL: https://github.com/Bioconductor/MatrixGenerics
BugReports: https://github.com/Bioconductor/MatrixGenerics/issues
RoxygenNote: 7.1.0
Roxygen: list(markdown = TRUE, old_usage = TRUE)
Suggests: 
    testthat (>= 2.1.0)
biocViews: Infrastructure, Software

Add SSH keys to your GitHub account. SSH keys
will are used to control access to accepted Bioconductor
packages. See these instructions to add SSH keys to
your GitHub account.

@PeteHaitch
Copy link
Author

We've discussed this package a bit over the years and it's thanks to @const-ae we've got something concrete to submit 🎉

I think the aim will be for DelayedMatrixStats to depend on MatrixGenerics in the next release (I've got a branch ready to go; https://github.com/PeteHaitch/DelayedMatrixStats/tree/MatrixGenerics).
Ultimately, I think it may be best to deprecate DelayedMatrixStats by incorporating it directly into DelayedArray (and perhaps HDF5Array if there are HDF5Matrix-specific methods).
@const-ae is also working on sparseMatrixStats but I'm not sure I've left him enough time to have that prepared for the next release ...

Pinging @hpages who will likely want to run an eye over it, and @HenrikBengtsson since this builds on matrixStats.

@bioc-issue-bot
Copy link
Collaborator

A reviewer has been assigned to your package. Learn what to expect
during the review process.

IMPORTANT: Please read the instructions for setting
up a push hook on your repository, or further changes to your
repository will NOT trigger a new build.

@bioc-issue-bot bioc-issue-bot added 2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place and removed 1. awaiting moderation labels Apr 1, 2020
@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 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.

@PeteHaitch
Copy link
Author

In the DESCRIPTION we have:

biocViews: Infrastructure, Software

Because it's an 'infrastructure' package I think this should mean that a vignette is not required.
Indeed, in the build report we see:

* Checking vignette directory...
    This is a software package
  Infrastructure package, vignette not required.

But then we immediately get an ERROR:

* Checking whether vignette is built with 'R CMD build'...
    * ERROR: Vignette must be built by 'R CMD build'. Please see the
      `Vignette Checks` section of the BiocCheck vignette.

And so the build fails.

Should we only have

biocViews: Infrastructure

in the DESCRIPTION?

@lshep
Copy link
Contributor

lshep commented Apr 2, 2020

Probably needs an adjustment in BiocCheck -- can you open an issue there for me to look into it? @dvantwisk ignore the vignette ERROR for now.

@dvantwisk
Copy link

I'll have a review of this package done soon.

@PeteHaitch
Copy link
Author

👋@dvantwisk - I totally understand that you're all busy right now, just wanted to make a gentle inquiry about the review status here given that the deadline is approaching. Thanks!
The current build error is due to a false-positive in BiocCheck, I believe.

@dvantwisk
Copy link

dvantwisk commented Apr 16, 2020

Hi,

I apologize for the delay. I've reviewed your package and I am happy to say that I don't have anything significant to add to it. It is very well written as is and I will accept it as is.

@dvantwisk dvantwisk added 3a. accepted will be ingested into Bioconductor daily builder for distribution and removed 2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place labels Apr 16, 2020
@bioc-issue-bot
Copy link
Collaborator

Your package has been accepted. It will be added to the
Bioconductor Git repository and nightly builds. Additional
information will be posed to this issue in the next several
days.

Thank you for contributing to Bioconductor!

@PeteHaitch
Copy link
Author

No worries at all, @dvantwisk, I appreciate how busy you must be.
Thank you!

@mtmorgan
Copy link
Contributor

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/PeteHaitch.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("MatrixGenerics"). The package 'landing page' will be created at

https://bioconductor.org/packages/MatrixGenerics

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3a. accepted will be ingested into Bioconductor daily builder for distribution ERROR
Projects
None yet
Development

No branches or pull requests

5 participants