Skip to content

GuangchuangYu/badger

Repository files navigation

badger: Badge for R Package

R build status

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

saythanks

⏬ 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:
  • release version (CRAN)
    • syntax: `r badge_cran_release("badger", "orange")`
    • badge:
  • r-universe version
    • syntax: `r badge_runiverse("and", "rossellhayes")`
    • badge: r-universe status badge
  • devel version
    • syntax: `r badge_devel("guangchuangyu/ggtree", "blue")`
    • badge:

Download stats for bioconductor

  • Total of total :)
    • syntax: `r badge_bioc_download("clusterProfiler", "total", "blue", "total")`
    • badge:
  • Total of distinct IPs
    • syntax: `r badge_bioc_download("clusterProfiler", "total", "yellow")`
    • badge:
  • Monthly download of distinct IPs
    • syntax: `r badge_bioc_download("clusterProfiler", "month", "green")`
    • badge:

Download stats for CRAN

  • Total downloads
    • syntax: `r badge_cran_download("badger", "grand-total", "blue")`
    • badge:
  • Monthly Downloads
    • syntax: `r badge_cran_download("badger", "last-month", "green")`
    • badge:
  • Weekly Downloads
    • syntax: `r badge_cran_download("badger", "last-week", "yellow")`
    • badge:

Impact

  • Altmetric score
    • syntax: `r badge_altmetric("10533079", "green")`
    • badge:

Academic

  • DOI
    • syntax: `r badge_doi("10.1111/2041-210X.12628", "yellow")`
    • badge:

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:
  • Project status
    • syntax: `r badge_repostatus("Active")`
    • badge: Project Status: Active - The project has reached a stable, usable state and is being actively developed.
  • License
    • syntax: `r badge_license("Artistic-2.0")`
    • badge: License: Artistic-2.0
  • travis build-status
    • syntax: `r badge_travis("rstudio/rmarkdown")`
    • badge:
  • coveralls code coverage
    • syntax: `r badge_coveralls("google/benchmark")`
    • badge:
  • codecov code coverage
    • syntax: `r badge_codecov("rcannood/princurve")`
    • badge:
  • code size
    • syntax: `r badge_code_size("GuangchuangYu/badger")`
    • badge:
  • last commit date
    • syntax: `r badge_last_commit("GuangchuangYu/badger")`
    • badge:
  • direct and recursive dependencies (for CRAN pkgs)
    • syntax: `r badge_dependencies("badger")`
    • badge: Dependencies
  • CRAN checks results
    • syntax: `r badge_cran_checks("badger")`
    • badge: CRAN checks
  • GitHub actions
    • syntax: `r badge_github_actions("rossellhayes/ipa")`
    • badge: R build status
  • CodeFactor code quality
    • syntax: `r badge_codefactor("rossellhayes/ipa")`
    • badge: CodeFactor

🔨 Related Tools