badger: Badge for R Package
![R build status](https://github.com/GuangchuangYu/badger/workflows/R-CMD-check/badge.svg?raw=true)
Query information and generate badge for using in README and GitHub
Pages.
Guangchuang YU https://guangchuangyu.github.io
School of Basic Medical Sciences, Southern Medical University
![](https://camo.githubusercontent.com/593a638943fdbdf2529953ca0ff8e8cd927dfdc68fb06f597b7f8f2d74dc214d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f666f6c6c6f772532306d652532306f6e2d5765436861742d677265656e2e737667)
Get the released version from CRAN:
install.packages("badger")
Or the development version from github:
## install.packages("devtools")
devtools::install_github("GuangchuangYu/badger")
- release version (bioconductor)
- syntax:
`r badge_bioc_release("ggtree", "green")`
- badge:
![](https://camo.githubusercontent.com/300d57c767043a59db55e034094c352488f76bfa83ef964e33272934316f40de/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f72656c6561736525323076657273696f6e2d332e382e302d677265656e2e737667)
- release version (CRAN)
- syntax:
`r badge_cran_release("badger", "orange")`
- badge:
![](https://camo.githubusercontent.com/55122fe76c502a65fee1d05d307e45e6f625e3cdc2774b03ef590ed069029948/68747470733a2f2f7777772e722d706b672e6f72672f6261646765732f76657273696f6e2f6261646765723f636f6c6f723d6f72616e6765)
- r-universe version
- syntax:
`r badge_runiverse("and", "rossellhayes")`
- badge:
![r-universe status badge](https://camo.githubusercontent.com/2ef4e73bf4891a0a43a2ce999f4a9540b01868a1691c91aa24177bdaae1aa819/68747470733a2f2f726f7373656c6c68617965732e722d756e6976657273652e6465762f6261646765732f616e64)
- devel version
- syntax:
`r badge_devel("guangchuangyu/ggtree", "blue")`
- badge:
![](https://camo.githubusercontent.com/4e011607fdf242c01598d75f157f34f81cf05f336fb23dc896f90a03f9943204/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f646576656c25323076657273696f6e2d302e322e332e3030312d626c75652e737667)
Download stats for bioconductor
- Total of total :)
- syntax:
`r badge_bioc_download("clusterProfiler", "total", "blue", "total")`
- badge:
![](https://camo.githubusercontent.com/1c2c32689f2e3cb1b36f3b3879166b8cee5a72807103b4e604d571e9122535cc/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f646f776e6c6f61642d313037313039372f746f74616c2d626c75652e737667)
- Total of distinct IPs
- syntax:
`r badge_bioc_download("clusterProfiler", "total", "yellow")`
- badge:
![](https://camo.githubusercontent.com/958a75796454c7606590a53e50ab739577e74903df6bffe19c76af53b04b22df/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f646f776e6c6f61642d3630353733372f746f74616c2d79656c6c6f772e737667)
- Monthly download of distinct IPs
- syntax:
`r badge_bioc_download("clusterProfiler", "month", "green")`
- badge:
![](https://camo.githubusercontent.com/16c05fea539525a788ec02492460ad64bcb758ce2c7fdb1181446f13894f5eac/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f646f776e6c6f61642d31333533322f6d6f6e74682d677265656e2e737667)
- Total downloads
- syntax:
`r badge_cran_download("badger", "grand-total", "blue")`
- badge:
![](https://camo.githubusercontent.com/c82efa0ec703734afbffdd0a81cc7740b92a3d65b377f4e87f94dee2eac91cdd/687474703a2f2f6372616e6c6f67732e722d706b672e6f72672f6261646765732f6772616e642d746f74616c2f6261646765723f636f6c6f723d626c7565)
- Monthly Downloads
- syntax:
`r badge_cran_download("badger", "last-month", "green")`
- badge:
![](https://camo.githubusercontent.com/3cd12f296414762b2925855aa7ee5d74e1145417db971a37a73bd68f817b280e/687474703a2f2f6372616e6c6f67732e722d706b672e6f72672f6261646765732f6c6173742d6d6f6e74682f6261646765723f636f6c6f723d677265656e)
- Weekly Downloads
- syntax:
`r badge_cran_download("badger", "last-week", "yellow")`
- badge:
![](https://camo.githubusercontent.com/52103fa606bee7f2e4a547e49cdc4ab905b4b8e3e5f0138c7051815016f54fe1/687474703a2f2f6372616e6c6f67732e722d706b672e6f72672f6261646765732f6c6173742d7765656b2f6261646765723f636f6c6f723d79656c6c6f77)
- Altmetric score
- syntax:
`r badge_altmetric("10533079", "green")`
- badge:
![](https://camo.githubusercontent.com/ae5236da5d8fca2a03c1ac33ca85d41aadc05e3410d2d9cc265b06ea2fb4a855/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f416c746d65747269632d2d677265656e2e737667)
- DOI
- syntax:
`r badge_doi("10.1111/2041-210X.12628", "yellow")`
- badge:
![](https://camo.githubusercontent.com/9ea1dac43934fc290d55717b9b6c0decb9a3c3613619144859948402416cc965/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f646f692d31302e313131312f323034312d2d323130582e31323632382d79656c6c6f772e737667)
- syntax:
`r badge_custom("1st most cited paper", "in OMICS", "blue", "http://online.liebertpub.com/action/showMostCitedArticles?journalCode=omi")`
- badge:
![](https://camo.githubusercontent.com/f8da359ecb74c5f6b37be84bb73b77cecc6dd462054748a41313aa7eb01f14b6/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f3173742532306d6f7374253230636974656425323070617065722d696e2532304f4d4943532d626c75652e737667)
- Lifecycle
- syntax:
`r badge_lifecycle("stable")`
- badge:
![](https://camo.githubusercontent.com/a70bd3b4878bce2a9b2b2ccb05260ae574ef59991ba9dc7f629f20915a285297/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6966656379636c652d737461626c652d627269676874677265656e2e737667)
- Project status
- syntax:
`r badge_repostatus("Active")`
- badge:
![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](https://camo.githubusercontent.com/2f7a95a01b9543e8dcac34358c343b1b2d75abb019511c5254490fb99a3c16fc/68747470733a2f2f7777772e7265706f7374617475732e6f72672f6261646765732f6c61746573742f6163746976652e737667)
- License
- syntax:
`r badge_license("Artistic-2.0")`
- badge:
![License: Artistic-2.0](https://camo.githubusercontent.com/02acf08a6602115f62c78f68fc02dc78aef36c842ce1299b59588c57ffb30d14/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d41727469737469632d2d322e302d626c75652e737667)
- travis build-status
- syntax:
`r badge_travis("rstudio/rmarkdown")`
- badge:
![](https://camo.githubusercontent.com/0aa985f2618473968b6a8a5b4c766f9acb353b3bb0b9c9ae53a72518d60d3d55/68747470733a2f2f7472617669732d63692e6f72672f7273747564696f2f726d61726b646f776e2e7376673f6272616e63683d6d6173746572)
- coveralls code coverage
- syntax:
`r badge_coveralls("google/benchmark")`
- badge:
![](https://camo.githubusercontent.com/4684829f67c6c13cf74705722f3c4f4f4d09e7c8ec275cef587c2a57cebc4dbc/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f676f6f676c652f62656e63686d61726b2f62616467652e7376673f6272616e63683d6d6173746572)
- codecov code coverage
- syntax:
`r badge_codecov("rcannood/princurve")`
- badge:
![](https://camo.githubusercontent.com/ae0e67536987a134b8537c4cae58acfaff35b44812ebbe3b59b9373b11d912a6/68747470733a2f2f636f6465636f762e696f2f67682f7263616e6e6f6f642f7072696e63757276652f6272616e63682f6d61737465722f67726170682f62616467652e737667)
- code size
- syntax:
`r badge_code_size("GuangchuangYu/badger")`
- badge:
![](https://camo.githubusercontent.com/3831ab5dc9d360837ae84fe0d4101da9915cb1cba129d64aeec90d9992a9f7af/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f636f64652d73697a652f4775616e67636875616e6759752f6261646765722e737667)
- last commit date
- syntax:
`r badge_last_commit("GuangchuangYu/badger")`
- badge:
![](https://camo.githubusercontent.com/16ae946e5622279e45fda88247b511a543fa3bbec6c28cd88e0a32cbcc8d86e4/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6173742d636f6d6d69742f4775616e67636875616e6759752f6261646765722e737667)
- direct and recursive dependencies (for CRAN pkgs)
- syntax:
`r badge_dependencies("badger")`
- badge:
![Dependencies](https://camo.githubusercontent.com/bcd0efb33e63f7641c062589706f3ffa1a2adb250f69a61f71719d7e77c3758b/68747470733a2f2f74696e7976657273652e6e65746c6966792e636f6d2f62616467652f626164676572)
- CRAN checks results
- syntax:
`r badge_cran_checks("badger")`
- badge:
![CRAN checks](https://camo.githubusercontent.com/500670adc037df6defd687011370d0cb365cc447effde38e6c97be310e9a312d/68747470733a2f2f6261646765732e6372616e636865636b732e696e666f2f73756d6d6172792f6261646765722e737667)
- GitHub actions
- syntax:
`r badge_github_actions("rossellhayes/ipa")`
- badge:
![R build status](https://github.com/rossellhayes/ipa/workflows/R-CMD-check/badge.svg?raw=true)
- CodeFactor code quality
- syntax:
`r badge_codefactor("rossellhayes/ipa")`
- badge:
![CodeFactor](https://camo.githubusercontent.com/7abd2a094aed2af96a3c58ae3b0e75573e6488cee0cbe24f63c3a9fa29421f55/68747470733a2f2f7777772e636f6465666163746f722e696f2f7265706f7369746f72792f6769746875622f726f7373656c6c68617965732f6970612f6261646765)