Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

miaSim #2346

Closed YagmurSimsekk closed 3 years ago

YagmurSimsekk commented 3 years 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 3 years ago

Hi @YagmurSimsekk

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: miaSim
Type: Package
Version: 0.99.0
Authors@R:
     c(person(given = "Karoline", family = "Faust", role = c("aut"),
    email = "karoline.faust@kuleuven.be"),
       person(given = "Yu", family = "Gao", role = c("aut"),
    email = "gaoyu19920914@gmail.com"),
       person(given = "Emma", family = "Gheysen", role = c("aut"),
    email = "emma.gheysen@student.kuleuven.be"),
       person(given = "Daniel Rios", family = "Garza", role = c("aut"),
    email = "danielrios.garza@kuleuven.be"),
       person(given = "Yagmur", family = "Simsek", role = c("cre", "aut"),
    email = "yagmur.simsek@hsrw.org"),
       person(given = "Leo", family = "Lahti", role = c("aut"),
    email = "leo.lahti@iki.fi",
    comment = c(ORCID = "0000-0001-5537-637X")))
Title: Microbiome Data Simulation
Description: 
    Microbiome time series simulation with generalized Lotka-Volterra model, 
    Self-Organized Instability (SOI), and other models. Hubbell's Neutral model
    is used to determine the abundance matrix. The resulting abundance matrix
    is applied to SummarizedExperiment or TreeSummarizedExperiment objects.
License: Artistic-2.0 | file LICENSE
biocViews: Microbiome, Software, Sequencing, DNASeq, ATACSeq, Coverage, Network
Encoding: UTF-8
LazyData: false
RoxygenNote: 7.1.2
Depends:
    SummarizedExperiment
Imports:
    deSolve,
    stats,
    methods,
    poweRlaw,
    utils
Suggests:
    rmarkdown,
    knitr,
    BiocStyle,
    devtools,
    testthat
URL: https://github.com/microbiome/miaSim
BugReports: https://github.com/microbiome/miaSim/issues
Roxygen: list(markdown = TRUE)
VignetteBuilder: knitr
bioc-issue-bot commented 3 years ago

A reviewer has been assigned to your package. Learn what to expect during the review process.

IMPORTANT: Please read this documentation for setting up remotes to push to git.bioconductor.org. It is required to push a version bump to git.bioconductor.org to trigger a new build.

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 commented 3 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

On one or more platforms, the build results were: "ABNORMAL". 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. This link will be 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/miaSim to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 3 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

Congratulations! The package built without errors or warnings on all platforms.

Please see the build report for more details. This link will be 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/miaSim to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

hpages commented 3 years ago

Hi,

Seems like you've decided to make all your functions generic functions with a single method. However I don't see a good reason for doing this (they all dispatch on their first argument which is expected to be a single number). More generally speaking, systematically defining generic functions when regular functions can be used is not good practice. Please make powerlawA(), randomA(), simulateGLV(), simulateHubbell(), simulateSOI(), and tDyn() regular functions.

Also, this is not how one is expected to install the development version of a Bioconductor package (from section 2.0.2 of your vignette):

remotes::install_github("microbiome/miaSim")

Bioconductor is an ecosystem with tight interaction between packages and installing directly from GitHub will not play well with this. To install the development version of a Bioconductor package, one should first install the development version of Bioconductor with:

BiocManager::install(version="devel")

Note that this command itself might require to first update R to R-devel.

Then, one installs the development version of any Bioconductor package with BiocManager::install(), like for the release version.

Please remove section 2.0.2 from your vignette.

Other than that, the package is ready for acceptance.

Thanks, H.

YagmurSimsekk commented 3 years ago

Hi @hpages ,

Thank you for your review! I have considered your points and changed the files. I could push them into main repository, but it didn't work for Bioconductor upstream repository. I kept getting this error even though my SSH keys and emails are matching and I have R W access to my package.

remote: FATAL: W refs/heads/main packages/miaSim YagmurSimsekk DENIED by fallthru remote: error: hook declined to update refs/heads/main To git.bioconductor.org:packages/miaSim.git ! [remote rejected] main -> main (hook declined) error: failed to push some refs to 'git.bioconductor.org:packages/miaSim.git'

Clearly, I must be missing something.

hpages commented 3 years ago

I don't know what's going on and I don't know how to help with this, sorry. But maybe @nturaga, @lshep, or @vjcitn can help? Thanks

lshep commented 3 years ago

It is the issue with the default naming branch. See Number 5 Notes on the http://bioconductor.org/developers/how-to/git/new-package-workflow/ page specifically doing git push upstream main:master

bioc-issue-bot commented 3 years ago

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

bioc-issue-bot commented 3 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

Congratulations! The package built without errors or warnings on all platforms.

Please see the build report for more details. This link will be 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/miaSim to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

hpages commented 3 years ago

Thanks for the changes @YagmurSimsekk . Note that you will need to re-roxygenize to refresh the man pages (they still contain \docType{methods} and aliases for the methods that are gone e.g. \alias{simulateGLV,numeric-method}). Please do this at your earliest convenience. I'm labeling the package as accepted.

Cheers, H.

bioc-issue-bot commented 3 years ago

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 commented 3 years ago

The master branch of your GitHub repository has been added to Bioconductor's git repository.

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

https://bioconductor.org/packages/miaSim

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.