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

RUCova #3620

Open
10 tasks done
astaburuaga-garcia opened this issue Oct 21, 2024 · 38 comments
Open
10 tasks done

RUCova #3620

astaburuaga-garcia opened this issue Oct 21, 2024 · 38 comments
Assignees
Labels
2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place OK

Comments

@astaburuaga-garcia
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 @astaburuaga-garcia

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: RUCova
Title: Removes unwanted covariance from mass cytometry data 
Version: 0.99.0
Authors@R: person("Rosario", "Astaburuaga-García", , "[email protected]", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-1179-4080"))
Description: Mass cytometry data is high dimensional and contains unwanted covariance induced by variations in cell size, staining and other technical artefacts. This package uses a set of linear models to model and remove unwanted covariance from this data.   
License: use_gpl3_license()
Encoding: UTF-8
biocViews: Software, SingleCell
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.2
Suggests: 
    knitr,
    rmarkdown,
    BiocManager
Imports:
    dplyr,
    tidyr,
    fastDummies,
    ggcorrplot,
    ggh4x,
    ggplot2,
    ggpubr,
    ggridges,
    stringr,
    tibble,
    Matrix,
    ComplexHeatmap,
    grid,
    remotes,
    circlize,
VignetteBuilder: knitr
Depends: 
    R (>= 2.10)
LazyData: true

@bioc-issue-bot bioc-issue-bot added the 1. awaiting moderation submitted and waiting clearance to access resources label Oct 21, 2024
@lshep lshep added the Post Release Deadline package submitted after posted deadline. reviewer will only review if time allows label Oct 25, 2024
@lshep lshep removed the Post Release Deadline package submitted after posted deadline. reviewer will only review if time allows label Nov 8, 2024
@lshep
Copy link
Contributor

lshep commented Nov 14, 2024

Please update you DESCRIPTION for a valid license field.

You mention mass cytometry but I don't see an integration with our common
Bioconductor class
for this data Spectra. Please provide interoperability with
this class.

Please remove commented out sections of vignette

@lshep lshep added 3e. pending pre-review changes review has indicated blocking concern that needs attention 3d. needs interop Package must explicitly use Bioconductor structures and methods labels Nov 14, 2024
@astaburuaga-garcia
Copy link
Author

astaburuaga-garcia commented Nov 25, 2024

Please update you DESCRIPTION for a valid license field.

Updated.

You mention mass cytometry but I don't see an integration with our common Bioconductor class for this data Spectra. Please provide interoperability with this class.

Our package works for mass cytometry data, not mass spectrometry (Spectra).

Please remove commented out sections of vignette

Done

@lshep
Copy link
Contributor

lshep commented Nov 27, 2024

It still seems like this could interact with common Bioconductor classes like a SummarizedExperiment and flowSet? You can see HDCytoData for reference

@lshep
Copy link
Contributor

lshep commented Dec 16, 2024

May we expect any updates soon?

@astaburuaga-garcia
Copy link
Author

Hi, yes. Sorry for the delay. I'm adapting the whole pipeline to interact with a SingleCellExperiment class. I'll write here as soon as it is implemented and in the devel branch.

@astaburuaga-garcia
Copy link
Author

Hi! I updated the functions and vignette so the workflow interacts with a SingleCellExperiment. The new implementation is on the devel branch.

@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 3d. needs interop Package must explicitly use Bioconductor structures and methods labels Jan 2, 2025
@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 Jan 2, 2025
@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.

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 Single Package Builder:
Linux (Ubuntu 24.04.1 LTS): RUCova_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
[email protected]:packages/RUCova 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: eb30353c7978f86ba0ac7cc9b18839a1199130c2

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

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 Single Package Builder:
Linux (Ubuntu 24.04.1 LTS): RUCova_0.99.8.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
[email protected]:packages/RUCova 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: d328d4a4c9b00a4035f2b1a8ce126a372e517c39

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

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 Single Package Builder:
Linux (Ubuntu 24.04.1 LTS): RUCova_0.99.9.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
[email protected]:packages/RUCova 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: 16c5b776f1b3ed2b0edc5ff85661abd4afe66197

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

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 Single Package Builder:
Linux (Ubuntu 24.04.1 LTS): RUCova_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
[email protected]:packages/RUCova 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: 700860a2fccc5abfc20cc45f683a3e9f6560e060

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

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 Single Package Builder:
Linux (Ubuntu 24.04.1 LTS): RUCova_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
[email protected]:packages/RUCova 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: c92f03f272f305a969ab5ad632a253a6488a6e23

@bioc-issue-bot
Copy link
Collaborator

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

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

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 Single Package Builder:
Linux (Ubuntu 24.04.1 LTS): RUCova_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
[email protected]:packages/RUCova 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: 2a97a3aa3f63c2ecaa53ccad140804cd98c20d0f

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

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 Single Package Builder:
Linux (Ubuntu 24.04.1 LTS): RUCova_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
[email protected]:packages/RUCova 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: 849114e1f904ad570c1d1d8f5f2feccd8e7522ed

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

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 Single Package Builder:
Linux (Ubuntu 24.04.1 LTS): RUCova_0.99.6.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
[email protected]:packages/RUCova 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: 5e8fa7f949bf596321de2f5fdf88e5f5422fd83f

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

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 Single Package Builder:
Linux (Ubuntu 24.04.1 LTS): RUCova_0.99.65.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
[email protected]:packages/RUCova 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: 81ba88dc5d15f1bd43844322f093b4400c95ce85

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

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 Single Package Builder:
Linux (Ubuntu 24.04.1 LTS): RUCova_0.99.66.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
[email protected]:packages/RUCova 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: dfa081b91d614202cb8629b565698301bb21bb5f

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

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 Single Package Builder:
Linux (Ubuntu 24.04.1 LTS): RUCova_0.99.67.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
[email protected]:packages/RUCova 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: 057908fed9ca2c615e61f63ad3f1adb78369ab14

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

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 Single Package Builder:
Linux (Ubuntu 24.04.1 LTS): RUCova_0.99.68.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
[email protected]:packages/RUCova 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: 8f6b646dc2f7f72e466c22f7f93ba36582ff6129

@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 24.04.1 LTS): RUCova_0.99.17.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
[email protected]:packages/RUCova to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@bioc-issue-bot bioc-issue-bot added OK and removed WARNINGS labels Jan 7, 2025
@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 Jan 14, 2025
@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.

@ttriche
Copy link
Contributor

ttriche commented Jan 30, 2025

Package Review Checklist

Version 1.0.1

This checklist is intended to aid and guide the reviewer through the review
process.
The individual checkboxes match the package review criteria listed here.
The package review itself (including comments) should be posted in the corresponding issue on the submission tracker.

Reviewers should be respectful and kind to the authors in the review process.
Following the code of conduct is mandatory for everyone involved in the review process.
Emphasis should be put on interoperability of the package and the re-use of code, concepts and classes from existing Bioconductor packages where it makes sense.
The functionality should be sufficiently documented in man pages with runnable examples and package vignette(s).

package name: RUCova
link to issue: #3620

Package name

General package development

  • R CMD build without errors, warnings and notes.
  • Package passes BiocCheck::BiocCheck(), BiocCheck::BiocCheckGitClone().
  • File names.
  • Package size.
  • R CMD check --no-build-vignettes within 10 minutes.
  • Memory requirement below 3GB.
  • Size of individual files <= 5MB.
  • README file.

The DESCRIPTION file

Refer to the DESCRIPTION section in the BioC package guideline for details on the individual points.

  • Package field.
  • Title field.
  • Version field.
  • Description field.
  • Authors@R field.
  • License field.
  • LazyData field.
  • Depends, Imports, Suggests, Enhances fields.
  • [N/A] SystemRequirements field.
  • biocViews field.
  • [NO] BugReports field.
  • [NO] URL field.
  • [N/A] Video field.
  • [N/A] Collate field.
  • [N/A] BiocType field.

The NAMESPACE file

  • Function names use camelCase or snake_case and do not include ..
  • Selective imports using importFrom instead of import all with import.
  • Individual functions/methods are exported instead of all.

The NEWS file

  • [NO] News file in correct location and format.

The CITATION file

  • Citation file (if present) in correct format
    (readCitationFile("inst/CITATION") without error).

Package data

  • Included data not too large. Need for separate data package?
  • Exported data and the data/ directory has correct format, is compressed and documented.
  • [N/A] Raw data in inst/extdata/ directory. Small enough to justify inclusion in package?
  • [N/A] If data downloaded from web: really necessary? BiocFileCache used?

Documentation

  • Vignette present and does describe the core functionality of the package.
  • No disabled code blocks present in vignette.
  • [NO] Vignette uses BiocStyle package for formatting.
  • reviewer needs to rebuild vignette under R-4.5 and Bioc-3.21
  • Vignette has an Introduction section. This should include motivation for inclusion to Bioconductor
  • Vignette has an Installation section.
  • Vignette has a table of contents.
  • When relevant, vignette provides review/comparison to other packages with similar functionality or scope
  • Vignette includes sessionInfo().
  • The vignettes/ directory contains only vignette file(s) and necessary static images.
  • All exported functions and classes have a man page.
  • [RUCova != rucova] Package man page present.
  • All man pages have runnable examples.

Unit tests

  • [NO] Unit tests present and covering large part of core functionality.

R code

  • All included code under open source license.
  • No warnings or errors in R CMD check.
  • No warnings or errors in BiocCheck().
  • [NO] Coding and syntax:
    • vapply instead of sapply.
    • TRUE, FALSE instead of T, F.
    • numeric indices.
    • is() instead of class().
    • system2 instead of system.
    • no set.seed() in any internal code.
    • no browser() in any internal code.
    • no <<-.
    • no direct slot access with @ or slot() - accessors implemented and used.
    • <- instead of =.
    • dev.new() instead of x11.
    • message(), warning, stop instead of cat. No paste0 in these
      methods.
  • Re-use of classes and functionality (if appropriate).
  • Functional programming: no code repetition.
  • No excessively long functions.
  • Function argument names descriptive and documented.
  • Function arguments should have defaults.
  • Function arguments are tested for validity.
  • Vectorize: no unnecessary for loops present.
  • Web resources follow the guideline Querying Web Resources.
  • [N/A] Parallelisation uses BiocParallel.
  • [N/A] Downloaded files cached with BiocFileCache.
  • Additional files and dependencies: nothing installed on a user's system.

C and Fortran code

  • [N/A] Internal functions from R's C library used (e.g. R_alloc).
  • [N/A] C function registration used (See Registering native routines.
  • [N/A] Checks for user interruption.
  • [N/A] Makevars and Makefile within a package.

Third-party code

  • [N/A] Inclusion of third-party code follows the guideline.

Shiny apps

  • [N/A] All relevant R-code is in the main R/ directory of the package.
  • [N/A] Core package code outside of the Shiny app.

Unacceptable files

  • No unacceptable files present (see .gitignore for a listing).

@lshep
Copy link
Contributor

lshep commented Jan 31, 2025

In addition to checklist @ttriche mentioned above my summary comments:

build report

  • Please clean up as many notes as possible

vignette

  • update your installation section to include bioconductor

  • In running the code there are a few warnings messages of deprecated
    functions. If you are using these deprecated functions directly, it is
    recommended to fix now to avoid ERRORs and immediate action later.

man

  • Please include a package level man page so a naive user that does
    ?RUCova gets some starting information

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

4 participants