Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

tanggle #2263

Closed KlausVigo closed 3 years ago

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

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: tanggle
Type: Package
Title: Visualization of Phylogenetic Networks
Version: 0.99.0
Authors@R: c(person("Klaus", "Schliep", email="klaus.schliep@gmail.com", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-2941-0161")),
   person("Marta", "Vidal-Garcia", role="aut"), 
   person("Claudia", "Solis-Lemus", role="aut", email="solislemus@wisc.edu", comment = c(ORCID = "0000-0002-9789-8915")), 
   person("Leann", "Biancani", role="aut"), 
   person("Eren", "Ada", role="aut"), 
   person("L. Francisco", "Henao Diaz", role="aut"), 
   person("Guangchuang", "Yu", role = c("ctb")))
Description: Offers functions for plotting split  (or implicit) networks (unrooted, undirected) 
    and explicit networks (rooted, directed) with reticulations extending.  
    'ggtree' and using functions from 'ape' and 'phangorn'. It extends the 
    'ggtree' package [@Yu2017]  to allow the visualization of phylogenetic 
    networks using the 'ggplot2' syntax. It offers an alternative to the plot 
    functions already available in 'ape' Paradis and Schliep (2019) 
    <doi:10.1093/bioinformatics/bty633> and 'phangorn' Schliep (2011) 
    <doi:10.1093/bioinformatics/btq706>.
Depends:
    R (>= 4.1),
    ggplot2 (>= 2.2.0),
    ggtree
Imports:
    ape (>= 5.0), 
    phangorn (>= 2.5),
    utils
Suggests:
    tinytest,
    BiocStyle,
    ggimage,
    knitr,
    rmarkdown
VignetteBuilder: knitr    
biocViews: Software, Visualization, Phylogenetics
License: Artistic-2.0
URL: https://klausvigo.github.io/tanggle, https://github.com/KlausVigo/tanggle
BugReports: https://github.com/KlausVigo/tanggle/issues
RoxygenNote: 7.1.1
Roxygen: list(old_usage = TRUE)
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: "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. 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/tanggle 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

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

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

jianhong commented 3 years ago

Package tanggle Review

The package is in pretty good shape. There are some minor issues need to be addressed.

General package development

The DESCRIPTION file

The NAMESPACE file

The NEWS file

Package data

Documentation

Unit tests

R code

Unacceptable files

bioc-issue-bot commented 3 years ago

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

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

KlausVigo commented 3 years ago

Dear Jianhong, thanks a lot for all your useful and constructive comments. I tried to address them and want to report on the changes / improvements.

Package tanggle Review

The package is in pretty good #shape. There are some minor issues need to be addressed.

General package development

* [x]  README file contain links to image file saved in man folder.

Done. Removed man folder and use images in inst/extdata

The DESCRIPTION file

* [x]  (optional) `Description` field. Please try to keep to an 80 character limit.

The NAMESPACE file

* [x]  Function names use `camelCase` or `snake_case` and do not include `.`.

renamed node.depth.evonet to node_depth_evonet

The NEWS file

* [ ]  News file is not up to date.

Will do this next.

Package data

* [x]  Raw data in `inst/extdata/` directory contain unrelated files and folders, eg. WebLogo.R, inst/extdata/pics.

I removed unrelated files.

Documentation

* [x]  Please include Bioconductor installation instructions using BiocManager for the package in _Installation_ section of Vignette.

* [x]  The `vignettes/` directory contains .gitignore file.

* [x]  (optional) Vignette line167, replace `seq` by `seq_along`, line215 display not correctly.
  Please try to keep to an 80 character limit as the code will otherwise be
  difficult to read when displayed online.

I replaced seq by seq_along. Apart from url's and some markdown tables lines are shorter than 80 characters. In fact I don't know how to shorten these.

* [x]  (optional) we highly recommend a package help page for users that naively
  do `?tanggle` that would point to main documentation or functions.

There is now a tanggle / tanggle-package man page.

* [x]  The `man/` directory contains `figures` subfolder.

Removed the folder.

Unit tests

* [x]  test_tanggle.R line14, `is()` instead of `class()`.

* [x]  Please clean up unused code.

Done.

R code

* [x]  Please clean up unused code.

* [x]  Function arguments are not tested for validity.

I added several test for validity.

Unacceptable files

* [x]  `.github` folder, `_pkgdown.yml` need to be removed.

I deleted the files.

I hope this changes brought us closer to bioconductor.

Kind regards, Klaus

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

https://bioconductor.org/packages/tanggle

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.