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

miaDash #3637

Open
10 tasks done
RiboRings opened this issue Nov 1, 2024 · 10 comments
Open
10 tasks done

miaDash #3637

RiboRings opened this issue Nov 1, 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

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

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: miaDash
Version: 0.99.0
Authors@R: 
    c(person(given = "Giulio", family = "Benedetti", role = c("aut", "cre"),
 email = "[email protected]",
 comment = c(ORCID = "0000-0002-8732-7692")),
    person(given = "Akewak", family = "Jeba", role = c("ctb"),
   email = "[email protected]",
   comment = c(ORCID = "0009-0007-1347-7552")),
    person(given = "Leo", family = "Lahti", role = c("aut"),
   email = "[email protected]",
   comment = c(ORCID = "0000-0001-5537-637X")))
Title: Shiny app for interactive analysis and exploration of microbiome data
Description:
    miaDash provides a Graphical User Interface for the exploration of
    microbiome data. This way, no knowledge of programming is required to
    perform analyses. Datasets can be imported, manipulated, analysed and
    visualised with a user-friendly interface.
biocViews: Microbiome, Software, Visualization, GUI, ShinyApps, DataImport
License: Artistic-2.0
Encoding: UTF-8
Depends:
    R (>= 4.4.0),
    iSEE
Imports:
    biomformat,
    iSEEtree,
    methods,
    mia,
    rintrojs,
    scater,
    shiny,
    shinyjs,
    S4Vectors,
    SingleCellExperiment,
    SummarizedExperiment,
    TreeSummarizedExperiment,
    utils,
    vegan
Suggests:
    BiocStyle,
    knitr,
    RefManageR,
    remotes,
    rmarkdown,
    testthat (>= 3.0.0)
URL: https://github.com/microbiome/miaDash
BugReports: https://github.com/microbiome/miaDash/issues
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.2
VignetteBuilder: knitr
Config/testthat/edition: 3

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

lshep commented Nov 22, 2024

Currently the vignette does not meet Bioconductor standards as there is no
executed R code. We might make an exception for a shiny app if testing coverage
is close to complete.I would recommend adding a secondary vignette in addition
to the one created that show the underling function calls and explains what they
do or increase or justify the missing coverage.

> covr::package_coverage()
miaDash Coverage: 60.61%
R/landing_page.R: 0.00%
R/miaDash.R: 0.00%
R/utils.R: 61.11%
R/observers.R: 87.50%
R/outputs.R: 100.00%

I'll move this forward but may require discussion during review.

@lshep lshep added the pre-check passed pre-review performed and ready to be added to git label Nov 22, 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 Nov 22, 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: "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 Single Package Builder:
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
[email protected]:packages/miaDash 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: 87bfa23ba892d4f73384f35b275daebb4388fc9d

@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): miaDash_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/miaDash 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 Nov 25, 2024
@RiboRings
Copy link
Author

Hi @lshep! Thanks for the useful remarks.

We might make an exception for a shiny app if testing coverage is close to complete.

I improved the coverage. However, many parts of the package are strictly interactive, so I had to exclude them from coverage tracking. I am open for suggestions if there is any way to test interactive code recommended by Bioconductor.

I would recommend adding a secondary vignette in addition
to the one created that show the underling function calls and explains what they
do

Just to understand better. Would you suggest to write a vignette that explains how the app works under the hood? For example, describing how the server and ui components interact and how other utility functions support them?

Thank you in advance!

@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 Nov 27, 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.

@bioc-issue-bot
Copy link
Collaborator

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

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

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