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

dandelionR #3680

Closed
10 tasks done
zktuong opened this issue Dec 13, 2024 · 38 comments
Closed
10 tasks done

dandelionR #3680

zktuong opened this issue Dec 13, 2024 · 38 comments
Assignees
Labels
3a. accepted will be ingested into Bioconductor daily builder for distribution OK

Comments

@zktuong
Copy link

zktuong commented Dec 13, 2024

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

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: dandelionR
Title: Single-cell Immune Repertoire Trajectory Analysis in R
Version: 0.99.0
Authors@R:
    c(person(given="Jiawei", family="Yu", email = "[email protected]", role = c("aut"), comment = c(ORCID = "0009-0005-9170-7881")),
      person(given="Nicholas", family="Borcherding", email = "[email protected]", role = c("aut"), comment = c(ORCID = "0000-0003-1427-6342")),
      person(given="Kelvin", family="Tuong", email = "[email protected]", role = c("aut", "cre"), comment = c(ORCID = "0000-0002-6735-6808")))
Description: dandelionR is an R package for performing single-cell immune repertoire trajectory analysis, based on the original python implementation. It provides the necessary functions to interface with scRepertoire and a custom implementation of an absorbing Markov chain for pseudotime inference, inspired by the Palantir Python package.
License: MIT + file LICENSE
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.2
biocViews: Software, ImmunoOncology, SingleCell
Collate:
    'check.R'
    'constructMarkovChain.R'
    'data.R'
    'determMultiscaleSpace.R'
    'terminalStateFromMarkovChain.R'
    'differentiationProbabilities.R'
    'filterCells.R'
    'getPbs.R'
    'projectProbability.R'
    'maxMinSampling.R'
    'minMaxScale.R'
    'markovProbability.R'
    'miloUmap.R'
    'projectPseudotimeToCell.R'
    'setupVdjPseudobulk.R'
    'splitCTgene.R'
    'vdjPseudobulk.R'
Imports:
    BiocGenerics,
    bluster,
    destiny, 
    igraph,
    MASS,
    Matrix,
    methods,
    miloR,
    purrr,
    rlang,
    S4Vectors,
    SingleCellExperiment,
    spam,
    stats,
    SummarizedExperiment,
    uwot
Suggests:
    BiocStyle,
    knitr,
    RColorBrewer,
    scater,
    scRepertoire,
    testthat
VignetteBuilder: knitr
URL: https://www.github.com/tuonglab/dandelionR/
BugReports: https://www.github.com/tuonglab/dandelionR/issues
Depends: 
    R (>= 4.4.0)

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

lshep commented Dec 18, 2024

I currently cannot get the package to build for local testing

R CMD build dandelionR 
* checking for file 'dandelionR/DESCRIPTION' ... OK
* preparing 'dandelionR':
* checking DESCRIPTION meta-information ... OK
* installing the package to build vignettes
* creating vignettes ... ERROR
--- re-building ‘vignette_from_scRepertoire.Rmd’ using rmarkdown

Quitting from lines 77-86 [unnamed-chunk-6] (vignette_from_scRepertoire.Rmd)
Error: processing vignette 'vignette_from_scRepertoire.Rmd' failed with diagnostics:
unused argument (filterNonproductive = TRUE)
--- failed re-building ‘vignette_from_scRepertoire.Rmd’

--- re-building ‘vignette_reproduce_original.rmd’ using rmarkdown
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
Warning in grid.Call.graphics(C_points, x$x, x$y, x$pch, x$size) :
  semi-transparency is not supported on this device: reported only once per page
Warning: The vignette title specified in \VignetteIndexEntry{} is different from the title in the YAML metadata. The former is "Reproducing the original dandelion method/paper"", and the latter is "Reproducing the original dandelion method/paper". If that is intentional, you may set options(rmarkdown.html_vignette.check_title = FALSE) to suppress this check.
--- finished re-building ‘vignette_reproduce_original.rmd’

SUMMARY: processing the following file failed:
  ‘vignette_from_scRepertoire.Rmd’

Error: Vignette re-building failed.
Execution halted

@lshep lshep added the 3e. pending pre-review changes review has indicated blocking concern that needs attention label Dec 18, 2024
@zktuong
Copy link
Author

zktuong commented Dec 19, 2024

hi @lshep, i'm told that it should work – as the bioconcductor 3.20 release has that argument in scRepertoire: https://code.bioconductor.org/browse/scRepertoire/blob/RELEASE_3_20/R/combineContigs.R#L55

In anycase, we have since gona back to edit the vignette to exclude the argument filterNonproductive = TRUE as that was the default anyway.

@lshep
Copy link
Contributor

lshep commented Dec 19, 2024

Your package is building against devel not release_3_20 and that argument does not exist there https://code.bioconductor.org/browse/scRepertoire/blob/devel/R/combineContigs.R#L52 . Through this review process make sure you are testing against R-devel and Bioc devel (soon to be 3.21)

@zktuong
Copy link
Author

zktuong commented Dec 19, 2024

ok thanks for that!

seems like the Bioc-devel version of scRepertoire is an outdated (different) version compared to the released version and that's causing the build to fail. i will work with @ncborcherding to resolve that first.

@zktuong
Copy link
Author

zktuong commented Dec 21, 2024

Hi @lshep, we are ready for this to be reviewed again. our tests are passing when built against R-devel and Bioc-devel https://github.com/tuonglab/dandelionR/actions/runs/12441168543

@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 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): dandelionR_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/dandelionR 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: 4f31e0fc66a85460216cef29b64e7f7f8b6e3ee4

@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): dandelionR_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/dandelionR 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: 1a94ac148261043e07fa5134e03a20b09b39e8ef

@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): dandelionR_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/dandelionR 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: d1a41fd7b0c2cbc16f15c256e0ae820de30319ca

@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): dandelionR_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
[email protected]:packages/dandelionR 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 ERROR labels Jan 3, 2025
@bioc-issue-bot
Copy link
Collaborator

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

@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): dandelionR_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/dandelionR 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 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.

@bioc-issue-bot bioc-issue-bot added WARNINGS and removed OK labels Feb 8, 2025
@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@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): dandelionR_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/dandelionR 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

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): dandelionR_0.99.7.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/dandelionR 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: 0aeecf700aeb57995d26e4989e5db9aaabb36c40

@bioc-issue-bot
Copy link
Collaborator

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

@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): dandelionR_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/dandelionR 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

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): dandelionR_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/dandelionR 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 ERROR labels Feb 8, 2025
@mireia-bioinfo
Copy link

Hi @zktuong, could you please provide a point-by-point response to my review? This will help me efficiently verify how each comment has been addressed. Thank you!

@zktuong
Copy link
Author

zktuong commented Feb 10, 2025

Hi @mireia-bioinfo, sure thing. Please see below for our response:

General

  • Remove LICENSE.md, it is not necessary to provide two license files, copyright info is already included in LICENSE.

We removed LICENSE.md.

  • We prefer the master branch be clean of other application files like _pkgdown.yml. Please move the file to a different branch or remove it.

We removed _pkgdown.yml.

README

  • Please update README.md to display installation instructions from Bioconductor. See Bioconductor package installation instructions on any current Bioconductor package landing page.

We included in the README.md and dandelionR.Rmd to now include

if (!requireNamespace("BiocManager", quietly = TRUE))
    install.packages("BiocManager")
BiocManager::install("dandelionR")

NAMESPACE

  • You seem to be importing the miloR package as a whole, while also importing specific functions with importFrom. We encourage selective imports using importFrom than importing all using import.

We have removed where we were importing miloR and used @importFrom miloR [function] wherever possible, except for nhoods<- which we couldn't get it to work, so we had to use miloR::nhoods directly.

Man pages

Done

R code

  • Wherever message() or warning() calls are used, consider adding a verbose = TRUE/FALSE argument to allow users to control whether progress messages are printed to the console.

Done. Now there's a verbose option with Default as TRUE.

  • requireNamespace() is only necessary for packages listed under Suggests: in the DESCRIPTION file, as they are not automatically installed or loaded. If a package is in Imports:, it is ensured to be installed when the package is installed, so there is no need to check for its availability with requireNamespace(). Instead, you should import specific functions using @importFrom package function in the documentation or call them explicitly with package::function(). Please check all your calls to requireNamespace and remove those that are unnecessary:
R/./projectProbability.R:    requireNamespace("stats")
R/./constructMarkovChain.R:    requireNamespace("Matrix")
R/./miloUmap.R:    requireNamespace("miloR")
R/./miloUmap.R:    requireNamespace("igraph")
R/./vdjPseudobulk.R:    requireNamespace("stats")
R/./getPbs.R:    requireNamespace("rlang")
R/./getPbs.R:        requireNamespace("stats")
R/./getPbs.R:        requireNamespace("Matrix")
R/./check.R:    requireNamespace("methods")
R/./check.R:    requireNamespace("methods")

We have went through and removed all requireNamespace() and used @importFrom. As mentioned above, we have to call miloR::nhoods explicitly as @importFrom miloR nhoods<- (or any variations of it) doesn't seem to work.

R/./projectProbability.R:    for (i in seq_len(n)) {
R/./projectProbability.R:        for (j in seq_len(n)) {
R/./constructMarkovChain.R:    for (i in seq_len(length(waypoints))) {
R/./maxMinSampling.R:    for (ind in colnames(data)) {
R/./maxMinSampling.R:        for (k in 2:no.iterations - 1) {
R/./vdjPseudobulk.R:        for (col_n in extract_cols) {
R/./getPbs.R:        for (anno_col in col_to_take) {
R/./terminalStateFromMarkovChain.R:    for (i in cells) {
R/./splitCTgene.R:            for (item in sublist) {

We have changed all of these to using apply family functions accordingly.

  • To improve clarity and ensure the function’s behavior is explicit, make sure that all functions use return() to specify the value being returned. Some functions that do not explicitly return are: projectPseudotimeToCell, .maxMinSampling, miloUmap, .minMaxScale, etc.

We have added return to all of the functions.

Check

  • Please address as many of the remaining BiocCheck notes as possible:
ℹ NOTE: The recommended function length is 50 lines or less. There are 4
functions greater than 50 lines.
The longest 5 functions are:
• setupVdjPseudobulk() (R/setupVdjPseudobulk.R): 262 lines
• ...
• markovProbability() (R/markovProbability.R): 70 lines
✔ Checking formatting of DESCRIPTION, NAMESPACE, man pages, R source, and vigne…
ℹ NOTE: Consider shorter lines; 267 lines (14%) are 80 characters long.
First few lines:
• R/constructMarkovChain.R#L74 aff <- exp(-(ids$x^2) / ([adaptive.st](http://adaptive.st/) ...
• ...
• vignettes/vignette_reproduce_original.rmd#L176 And that's it! We have
successfully infe ...
ℹ NOTE: Consider multiples of 4 spaces for line indents; 6 lines (0%) are not.
First few lines:
• R/vdjPseudobulk.R#L61 "v_call_ab ...
• ...
• R/vdjPseudobulk.R#L66 ), col_to_take ...
ℹ See https://contributions.bioconductor.org/r-code.html
ℹ See styler package: https://cran.r-project.org/package=styler as described in
the BiocCheck vignette.

We have fixed all of the notes and there's no more BiocCheck Notes.

Vignette

  • It is not entirely clear which vignette users should refer to when getting started with the package. I assume vignette_from_scRepertoire.Rmd serves this purpose, as it includes a brief package description and installation instructions. To improve clarity, I recommend renaming this vignette to dandelionR.Rmd, making it more intuitive for users to access the introductory vignette with vignette("dandelionR").

We have renamed the notebook accordingly to dandelionR.Rmd.

We have added this to the top of the two markdown documents.

dandelionR.md

---
title: "Starting From scRepertoire"
output:
  BiocStyle::html_document:
    toc: true
    toc_depth: 2
    number_sections: true
knitr:
  opts_chunk:
    dev: 'png'
    fig.align: 'left'
date: "`r Sys.Date()`"
vignette: >
  %\VignetteIndexEntry{Starting From scRepertoire}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

vignette_reproduce_original.rmd

---
title: "Reproducing the original dandelion method/paper"
output:
  BiocStyle::html_document:
    toc: true
    toc_depth: 2
    number_sections: true
knitr:
  opts_chunk:
    dev: 'png'
    fig.align: 'left'
date: "`r Sys.Date()`"
vignette: >
  %\VignetteIndexEntry{Reproducing the original dandelion method/paper}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---
  • No code chunks necessary for running the vignette should be hidden for the user. Please remove include=FALSE from the chunk loading the destiny package or, since it is being loaded later, remove this specific chunk.

This is now removed completely and evaluated properly later when the destiny section comes on.

vignette_from_scRepertoire.Rmd

  • Update to display installation instructions from Bioconductor. See Bioconductor package installation instructions on any current Bioconductor package landing page.

Added now as per above.

  • When you mention “Check out the other vignette for an example dataset” it would be useful to include the code for accessing it: vignette("vignette_reproduce_original")

Done and added to the vignette!

@mireia-bioinfo
Copy link

Hi @zktuong,

Thank you for addressing all the points in my review. I just have a few remaining minor comments:

Vignette dandelionR.Rmd

  • When I mentioned that it would be useful to include the code for accessing the second vignette in the main one, I meant to make it visible to the users reading the vignette, so they can easely acess it if they're interested. Something like:

    Check out the other vignette for an example dataset that starts from the original dandelion output associated with the original manuscript: vignette("vignette_reproduce_original").

    You included the code but in a chunk with include=FALSE, which means that it doesn't appear in the rendered vignette and thus it is not visible to the people following the vignette.

  • The hierarchy of sections in the vignette is not well-structured. Currently, everything is placed under the 'Foreword' section. Please adjust the section headings to properly reflect the content structure.

  • Could you also make the vignette title more descriptive? It currently is "Starting From scRepertoire", which is a bit vague. For example, it could be something like "Single-cell immune repertoire trajectory analysis with dandelionR".

As soon as these are addressed I will proceed with accepting the package.

@bioc-issue-bot
Copy link
Collaborator

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

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

@zktuong
Copy link
Author

zktuong commented Feb 14, 2025

hi @mireia-bioinfo, thanks again. I've fixed all of the below.

Vignette dandelionR.Rmd

[x] When I mentioned that it would be useful to include the code for accessing the second vignette in the main one, I meant to make it visible to the users reading the vignette, so they can easely acess it if they're interested. Something like:

Check out the other vignette for an example dataset that starts from the original dandelion output associated with the original manuscript: vignette("vignette_reproduce_original").
You included the code but in a chunk with include=FALSE, which means that it doesn't appear in the rendered vignette and thus it is not visible to the people following the vignette.

include=FALSE has been removed

[x] The hierarchy of sections in the vignette is not well-structured. Currently, everything is placed under the 'Foreword' section. Please adjust the section headings to properly reflect the content structure.

This has been fixed/reordered.

[x] Could you also make the vignette title more descriptive? It currently is "Starting From scRepertoire", which is a bit vague. For example, it could be something like "Single-cell immune repertoire trajectory analysis with dandelionR".

Yes sorry this is fixed now.

@mireia-bioinfo
Copy link

Hi @zktuong,

Thank you for addressing my comments. I'll go ahead and accept the package now. Thank you for your contribution to Bioconductor!

@mireia-bioinfo mireia-bioinfo 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 Feb 17, 2025
@bioc-issue-bot
Copy link
Collaborator

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
Copy link
Contributor

lshep commented Feb 18, 2025

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

https://bioconductor.org/packages/dandelionR

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.

@lshep lshep closed this as completed Feb 18, 2025
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 OK
Projects
None yet
Development

No branches or pull requests

4 participants