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

bugphyzz #3367

Open
10 tasks done
sdgamboa opened this issue Mar 22, 2024 · 14 comments
Open
10 tasks done

bugphyzz #3367

sdgamboa opened this issue Mar 22, 2024 · 14 comments
Assignees
Labels
2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place OK

Comments

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

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: bugphyzz
Title: A harmonized data resource and software for enrichment analysis of microbial physiologies
Version: 0.99.0
Authors@R: 
    c(
        person(
  given = "Samuel",
  family = "Gamboa",
  role = c("aut", "cre"),
  email = "Samuel.Gamboa.Tuz@gmail.com",
  comment = c(ORCID = "0000-0002-6863-7943")
        ),
        person(
  given = "Levi",
  family = "Waldron",
  role = c("aut"),
  email = "levi.waldron@sph.cuny.edu",
  comment = c(ORCID = "0000-0003-2725-0694")
        ),
        person(
  given = "Kelly",
  family = "Eckenrode",
  role = c("aut")
        ),
        person(
  given = "Jonathan",
  family = "Ye",
  role = c("aut")
        ),
        person(
  given = "Jennifer",
  family = "Wokaty",
  role = c("aut")
        )
    )
Description: bugphyzz is an electronic database of standardized microbial
  annotations. It facilitates the creation of microbial signatures based on
  shared attributes, which are utilized for bug set enrichment analysis. The
  data also includes annotations imputed with ancestra state
  reconstruction methods.
biocViews:
    MicrobiomeData,
    ReproducibleResearch
License: Artistic-2.0
Config/testthat/edition: 3
Encoding: UTF-8
LazyData: false
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.1
VignetteBuilder: knitr
Depends: 
    R (>= 4.4)
Imports: 
    dplyr,
    utils,
    purrr,
    stringr,
    tidyr,
    tidyselect,
    BiocFileCache,
    httr2,
    tools
Suggests: 
    DT,
    forcats,
    ggplot2,
    htmltools,
    taxizedb,
    knitr,
    rmarkdown,
    sessioninfo,
    taxize,
    testthat,
    EnrichmentBrowser,
    MicrobiomeBenchmarkData,
    mia,
    stats,
    rlang,
    limma,
    mgsub,
    methods,
    readr,
    crayon,
    tibble,
    magrittr,
    tidytext,
    BiocStyle
URL: https://github.com/waldronlab/bugphyzz
BugReports: https://github.com/waldronlab/bugphyzz/issues

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

lshep commented Mar 28, 2024

We don't allow data to be store in github. Please store data on zenodo or some other trusted server. If a trusted serve is not available please consider using ExperimentHub.

@sdgamboa
Copy link
Author

sdgamboa commented Apr 17, 2024

@lshep, we have published our data on zenodo and use it as the default option in our main function.

A couple of functions still use data from external sites. One of them is not exported. The other is exported, but we wrote in the documentation that it should be used by curator/developers. These functions are not used in any other function meant for end users.

Finally, a dataset that was originally imported from a github repo is now included in the
inst/extadata directory with a description in inst/scripts.

Please let me know if I need to make more changes.

Thank you!

@lshep
Copy link
Contributor

lshep commented May 17, 2024

Please also include a section in the vignette that is similar to an abstract describing why you are submitting the package to bioconductor and a comparison to an existing Bioconductor packages.

@lshep lshep added pre-check passed pre-review performed and ready to be added to git pre-review on bioconductor git and access to on demand build but not assigned reviewer until build report clean and removed 3e. pending pre-review changes review has indicated blocking concern that needs attention 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 17, 2024
@lshep
Copy link
Contributor

lshep commented May 17, 2024

We have added the package to git.bioconductor.org but I am having trouble kicking off an initial build of the package. I'm currently investigating.

@lshep
Copy link
Contributor

lshep commented May 17, 2024

For Now this should be true:

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

@lshep
Copy link
Contributor

lshep commented May 17, 2024

Figured out the issue. If you have difficulty triggering builds with pushes to git.bioconductor.org let me know and I can try to reprocess the package but I think it should be okay.

@bioc-issue-bot
Copy link
Collaborator

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

@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: "skipped, 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:
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
git@git.bioconductor.org:packages/bugphyzz to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@sdgamboa
Copy link
Author

@lshep, I added an abstract to the vignette and expanded the introduction to describe the package in more detail. I explain how the package should fit within Bioconductor workflows and related packages. Please let me know if that fulfills the request.

I got an error in the build, but I think this is a problem with one of the dependencies of another package (mia):

===============================

 R CMD BUILD

===============================

* checking for file bugphyzz/DESCRIPTION ... OK
* preparing bugphyzz:
* checking DESCRIPTION meta-information ... OK
* installing the package to build vignettes
* creating vignettes ... ERROR
--- re-building bugphyzz.Rmd using rmarkdown

Quitting from lines 291-294 [unnamed-chunk-9] (bugphyzz.Rmd)
Error: processing vignette 'bugphyzz.Rmd' failed with diagnostics:
package or namespace load failed for 'mia' in loadNamespace(i, c(lib.loc, .libPaths()), versionCheck = vI[[i]]):
 there is no package called 'scuttle'
--- failed re-building bugphyzz.Rmd

SUMMARY: processing the following file failed:
  bugphyzz.Rmd

Error: Vignette re-building failed.
Execution halted

@bioc-issue-bot
Copy link
Collaborator

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

@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): bugphyzz_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
git@git.bioconductor.org:packages/bugphyzz 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 May 21, 2024
@lshep lshep added the 2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place label May 28, 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 bioc-issue-bot removed the pre-review on bioconductor git and access to on demand build but not assigned reviewer until build report clean label May 28, 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