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

scDotPlot #3424

Open
10 tasks done
ben-laufer opened this issue May 16, 2024 · 10 comments
Open
10 tasks done

scDotPlot #3424

ben-laufer opened this issue May 16, 2024 · 10 comments
Assignees
Labels
2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place OK

Comments

@ben-laufer
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 @ben-laufer

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: scDotPlot
Title: Cluster a Single-cell RNA-seq Dot Plot
Version: 0.99.0
Authors@R: c(
    person(given = c("Benjamin", "I"),
 family = "Laufer",
 role = c("aut", "cre"),
 email = "blaufer@gmail.com"),
    person(given = c("Brad", "A"),
 family = "Friedman",
 role = c("aut")))
Description: Dot plots of single-cell RNA-seq data allow for an examination of the relationships between cell groupings (e.g. clusters) and marker gene expression. The scDotPlot package offers a unified approach to perform a hierarchical clustering analysis and add annotations to the columns and/or rows of a scRNA-seq dot plot. It works with SingleCellExperiment and Seurat objects as well as data frames.
License: Artistic-2.0
URL: https://github.com/ben-laufer/scDotPlot
BugReports: https://github.com/ben-laufer/scDotPlot/issues
biocViews: 
    Software,
    Visualization,
    DifferentialExpression,
    GeneExpression,
    Transcription,
    RNASeq,
    SingleCell,
    Sequencing,
    Clustering
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.1
Depends:
    R (>= 4.4.0)
Imports: 
    aplot,
    BiocGenerics,
    cli,
    dplyr,
    ggplot2,
    ggsci,
    ggtree,
    grDevices,
    magrittr,
    purrr,
    rlang,
    scales,
    scater,
    Seurat,
    SingleCellExperiment,
    stats,
    stringr,
    tibble,
    tidyr
Suggests: 
    AnnotationDbi,
    knitr,
    rmarkdown,
    scQC,
    scran,
    scRNAseq,
    scuttle,
    SeuratObject
VignetteBuilder: knitr
LazyData: false

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

lshep commented May 20, 2024

All package dependencies must be on CRAN or Bioconductor. It does not appear that scQC is. You will need to ask the maintainers to submit to CRAN/Bioconductor or not reference/utilize this as a package dependency.

@lshep lshep added the 3e. pending pre-review changes review has indicated blocking concern that needs attention label May 20, 2024
@ben-laufer
Copy link
Author

I've removed that package suggestion, since it was no longer needed.

@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 May 29, 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 May 29, 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.

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 22.04.3 LTS): scDotPlot_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/scDotPlot 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 Jun 3, 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.

@jianhong
Copy link

jianhong commented Jun 4, 2024

Package 'scDotPlot' Review

Thank you for submitting your package to Bioconductor. The package passed check and build. It is in pretty good shape. Please try to answer the comments line by line when you are ready for a second review.
Code: Note: please consider; Important: must be addressed.

The DESCRIPTION file

  • NOTE: Consider adding the maintainer's ORCID iD in 'Authors@R' with
    'comment=c(ORCID="...")'

The NAMESPACE file

  • Important: Selective imports using importFrom instead of import all with import.
    • in line 7 import(aplot)
    • in line 8 import(ggplot2)
    • in line 9 import(ggtree)

General package development

R code

  • Important: no direct slot access with @ or slot() - accessors implemented and used. You may want to check function [[.
  • NOTE: :: is not suggested in source code unless you can make sure all the packages are imported. Some people think it is better to keep ::. However, please be aware that you will need to manually double-check the imported items if you make any changes to the DESCRIPTION file during development. My suggestion is to remove one or two repetitions to trigger the dependency check.

@bioc-issue-bot
Copy link
Collaborator

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

@ben-laufer
Copy link
Author

Hi @jianhong, thank you for reviewing scDotPlot. All important comments have been addressed in the line by line response.

The DESCRIPTION file

  • NOTE: Consider adding the maintainer's ORCID iD in 'Authors@R' with
    'comment=c(ORCID="...")'

The NAMESPACE file

  • Important: Selective imports using importFrom instead of import all with import.

    • in line 7 import(aplot)
    • in line 8 import(ggplot2)
    • in line 9 import(ggtree)

These have been replaced by selective imports.

General package development

  • Important: Please fix the package size issue.

The package size should no longer result in a warning.

Unit tests have been added.

R code

  • Important: no direct slot access with @ or slot() - accessors implemented and used. You may want to check function [[.

The code has been changed to remove this.

  • NOTE: :: is not suggested in source code unless you can make sure all the packages are imported. Some people think it is better to keep ::. However, please be aware that you will need to manually double-check the imported items if you make any changes to the DESCRIPTION file during development. My suggestion is to remove one or two repetitions to trigger the dependency check.

@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): scDotPlot_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/scDotPlot 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 Jun 6, 2024
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