badger: Badge for R Package
Query information and generate badge for using in README and GitHub Pages.
✍️ Author
Guangchuang YU https://guangchuangyu.github.io
School of Basic Medical Sciences, Southern Medical University
⏬ Installation
Get the released version from CRAN:
install.packages("badger")Or the development version from github:
## install.packages("devtools")
devtools::install_github("GuangchuangYu/badger")📖 Examples
Package Version
- release version (bioconductor)
- syntax:
`r badge_bioc_release("ggtree", "green")` - badge:
- syntax:
- release version (CRAN)
- syntax:
`r badge_cran_release("badger", "orange")` - badge:
- syntax:
- r-universe version
- syntax:
`r badge_runiverse("and", "rossellhayes")` - badge:
- syntax:
- devel version
- syntax:
`r badge_devel("guangchuangyu/ggtree", "blue")` - badge:
- syntax:
Download stats for bioconductor
- Total of total :)
- syntax:
`r badge_bioc_download("clusterProfiler", "total", "blue", "total")` - badge:
- syntax:
- Total of distinct IPs
- syntax:
`r badge_bioc_download("clusterProfiler", "total", "yellow")` - badge:
- syntax:
- Monthly download of distinct IPs
- syntax:
`r badge_bioc_download("clusterProfiler", "month", "green")` - badge:
- syntax:
Download stats for CRAN
- Total downloads
- syntax:
`r badge_cran_download("badger", "grand-total", "blue")` - badge:
- syntax:
- Monthly Downloads
- syntax:
`r badge_cran_download("badger", "last-month", "green")` - badge:
- syntax:
- Weekly Downloads
- syntax:
`r badge_cran_download("badger", "last-week", "yellow")` - badge:
- syntax:
Impact
- Altmetric score
- syntax:
`r badge_altmetric("10533079", "green")` - badge:
- syntax:
Academic
- DOI
- syntax:
`r badge_doi("10.1111/2041-210X.12628", "yellow")` - badge:
- syntax:
Customize badge
- syntax:
`r badge_custom("1st most cited paper", "in OMICS", "blue", "http://online.liebertpub.com/action/showMostCitedArticles?journalCode=omi")` - badge:
Development
- Lifecycle
- syntax:
`r badge_lifecycle("stable")` - badge:
- syntax:
- Project status
- syntax:
`r badge_repostatus("Active")` - badge:
- syntax:
- License
- syntax:
`r badge_license("Artistic-2.0")` - badge:
- syntax:
- travis build-status
- syntax:
`r badge_travis("rstudio/rmarkdown")` - badge:
- syntax:
- coveralls code coverage
- syntax:
`r badge_coveralls("google/benchmark")` - badge:
- syntax:
- codecov code coverage
- syntax:
`r badge_codecov("rcannood/princurve")` - badge:
- syntax:
- code size
- syntax:
`r badge_code_size("GuangchuangYu/badger")` - badge:
- syntax:
- last commit date
- syntax:
`r badge_last_commit("GuangchuangYu/badger")` - badge:
- syntax:
- direct and recursive dependencies (for CRAN pkgs)
- syntax:
`r badge_dependencies("badger")` - badge:
- syntax:
- CRAN checks results
- syntax:
`r badge_cran_checks("badger")` - badge:
- syntax:
- GitHub actions
- syntax:
`r badge_github_actions("rossellhayes/ipa")` - badge:
- syntax:
- CodeFactor code quality
- syntax:
`r badge_codefactor("rossellhayes/ipa")` - badge:
- syntax:
🔨 Related Tools
- hexSticker: create hexagon sticker in R