Bioconductor / Contributions

Contribute Packages to Bioconductor
131 stars 33 forks source link

mapper #3419

Open haihuilab opened 1 month ago

haihuilab commented 1 month ago

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 am familiar with the essential aspects of Bioconductor software management, including:

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 commented 1 month ago

Dear @haihuilab,

The package version number, '1.99.1', does not start with 0. Expecting format: '0.99.z' for new packages. Starting with non-zero x of 'x.y.z' format is generally only allowed if the package has been pre-released.

We recommend fixing the version number. See Bioconductor version numbers Please also consider running BiocCheck::BiocCheck('new-package'=TRUE) on your package to look for other Bioconductor package requirements.

bioc-issue-bot commented 1 month ago

Hi @haihuilab

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: mapper
Title: A wrapper of `purrr` and `furrr` packages for easy parallel mapping in R (mapper)
Version: 1.99.1
Maintainer: Haihui Zhang <zhanghaihui@pku.edu.cn>
Authors@R: 
    person("Haihui", "Zhang", , "zhanghaihui@pku.edu.cn", role = c("aut", "cre"),
 comment = c(ORCID = "0009-0006-4619-4500"))
Description: You just need to change `map` function to `mapper` function (and also other mapping functions) for parallel calculation.
License: MIT + file LICENSE
VignetteBuilder: knitr
biocViews: Software, StatisticalMethod, Visualization
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.1
Imports: 
    furrr,
    future,
    magrittr,
    parallel,
    purrr
Suggests: 
    testthat (>= 3.0.0)
Config/testthat/edition: 3
haihuilab commented 1 month ago

Thank you so much! I have changed the version to 0.99.0

lshep commented 1 month ago

You need to resubmit as a new issue so that other prechecks will also pass

lshep commented 1 month ago

The package documentation is not sufficient for Bioconductor standards. There are no man pages and the vignette needs much more detail on what the package does and providing examples. There is also no interopability with existing Bioconductor classes. Please show how this would work into a Bioconductor workflow/pipeline with existing Bioconductor class structures. See http://contributions.bioconductor.org/develop-overview.html . The vignette should also include an abstract/intro section in your vignette that provides motivation for inclusion in Bioconductor and when appropriate a review and comparison to existing Bioconductor packages with similar functionality or scope.

lshep commented 1 week ago

May we expect any updates soon?