Package 'badger'

Title: Badge for R Package
Description: Query information and generate badge for using in README and GitHub Pages.
Authors: Guangchuang Yu [aut, cre] , Gregor de Cillia [ctb], Dirk Eddelbuettel [ctb], Maëlle Salmon [ctb], Robrecht Cannoodt [ctb] (<https://orcid.org/0000-0003-3641-729X>, rcannood), Alexander Rossell Hayes [ctb] (<https://orcid.org/0000-0001-9412-0457>, rossellhayes), Waldir Leoncio [ctb], Matthew Schuelke [ctb] (<https://orcid.org/0000-0001-5755-1725>, the-mad-statter)
Maintainer: Guangchuang Yu <[email protected]>
License: Artistic-2.0
Version: 0.2.4.001
Built: 2024-11-08 04:43:40 UTC
Source: https://github.com/guangchuangyu/badger

Help Index

badge_altmetric

Description

altmetric badge

Usage

badge_altmetric(id, color)

Arguments

id

altmetric id
color

color of badge

Value

badge in markdown syntax

Author(s)

Guangchuang

Examples

## Not run: 
badge_altmetric("2788597", "blue")

## End(Not run)

badge_bioc_download

Description

badge of bioconductor download number

Usage

badge_bioc_download(pkg = NULL, by, color, type = "distinct")

Arguments

pkg

package. If NULL (the default) the package is determined via the DESCRIPTION file.
by

one of total or month
color

badge color
type

one of distinct and total

Value

badge in markdown syntax

Author(s)

Guangchuang Yu

badge_bioc_download_rank

Description

official Bioconductor download badge (download ranking)

Usage

badge_bioc_download_rank(pkg = NULL)

badge_download_bioc(pkg = NULL)

Arguments

pkg

package. If NULL (the default) the package is determined via the DESCRIPTION file.

Value

bioc download ranking badge

Author(s)

guangchuang yu

badge_bioc_release

Description

badge of bioconductor release version

Usage

badge_bioc_release(pkg = NULL, color)

Arguments

pkg

package. If NULL (the default) the package is determined via the DESCRIPTION file.
color

badge color

Value

badge in markdown syntax

Author(s)

Guangchuang Yu

badge_code_size

Description

badge of GitHub code size

Usage

badge_code_size(ref = NULL)

Arguments

ref

Reference for a GitHub repository. If NULL (the default), the reference is determined by the URL field in the DESCRIPTION file.

Value

badge in markdown syntax

Author(s)

Gregor de Cillia

badge_codecov

Description

badge of codecov code coverage

Usage

badge_codecov(ref = NULL, token = NULL, branch = NULL)

Arguments

ref

Reference for a GitHub repository. If NULL (the default), the reference is determined by the URL field in the DESCRIPTION file.
token

Codecov graphing token, needed for private repositories. It can be obtained at https://codecov.io/gh/USER/REPO/branch/BRANCH/graph/
branch

The GitHub branch. If NULL (the default), the default branch is automatically determined.

Value

badge in markdown syntax

Author(s)

Gregor de Cillia

CodeFactor badge

Description

CodeFactor badge

Usage

badge_codefactor(ref = NULL)

Arguments

ref

Reference for a GitHub repository. If NULL (the default), the reference is determined by the URL field in the DESCRIPTION file.

Value

badge in markdown syntax

Author(s)

Alexander Rossell Hayes

badge_coveralls

Description

badge of coveralls code coverage

Usage

badge_coveralls(ref = NULL, branch = NULL)

Arguments

ref

Reference for a GitHub repository. If NULL (the default), the reference is determined by the URL field in the DESCRIPTION file.
branch

The GitHub branch. If NULL (the default), the default branch is automatically determined.

Value

badge in markdown syntax

Author(s)

Gregor de Cillia

badge_cran_checks

Description

CRAN checks badge

Usage

badge_cran_checks(pkg = NULL, worst = FALSE)

Arguments

pkg

package. If NULL (the default) the package is determined via the DESCRIPTION file.
worst

logical; if FALSE (default) return "summary" badge. If TRUE, return "worst" badge.

Value

badge in Markdown syntax

Author(s)

Scott Chamberlain (badges API), Maëlle Salmon (function)

badge_cran_download

Description

badge of CRAN downloads

Usage

badge_cran_download(
  pkg = NULL,
  type = c("last-month", "last-week", "grand-total"),
  color = NULL
)

Arguments

pkg

package. If NULL (the default) the package is determined via the DESCRIPTION file.
type

type of stats. last-month, last-week or "grand-total"
color

color of badge

Value

badge in markdown syntax

Author(s)

Gregor de Cillia

badge_cran_release

Description

badge of CRAN version

Usage

badge_cran_release(pkg = NULL, color = NULL)

Arguments

pkg

package. If NULL (the default) the package is determined via the DESCRIPTION file.
color

color of badge

Value

badge in markdown syntax

Author(s)

Gregor de Cillia

badge_custom

Description

custom badge

Usage

badge_custom(x, y, color, url = NULL)

Arguments

x

field 1
y

field 2
color

color
url

optional url

Value

customize badge

Author(s)

Guangchuang Yu

badge_depedencies

Description

dependency badge

Usage

badge_dependencies(pkg = NULL)

Arguments

pkg

package. If NULL (the default) the package is determined via the DESCRIPTION file.

Value

badge in markdown syntax

Author(s)

Dirk Eddelbuettel

badge_devel

Description

badge of devel version

Usage

badge_devel(pkg = NULL, color)

Arguments

pkg

package. If NULL (the default) the package is determined via the DESCRIPTION file.
color

badge color

Value

badge in markdown syntax

badge_doi

Description

doi badge

Usage

badge_doi(doi, color)

Arguments

doi

doi
color

color

Value

badge

Author(s)

Guangchuang

Examples

badge_doi("10.1111/2041-210X.12628", "green")

GitHub Actions badge

Description

GitHub Actions badge

Usage

badge_github_actions(ref = NULL, action = "R-CMD-check")

Arguments

ref

Reference for a GitHub repository. If NULL (the default), the reference is determined by the URL field in the DESCRIPTION file.
action

The name of the GitHub actions workflow. Defaults to "R-CMD-CHECK".

Value

badge in markdown syntax

Author(s)

Alexander Rossell Hayes

GitHub Release badge

Description

GitHub Release badge

Usage

badge_github_release(ref = NULL)

Arguments

ref

Reference for a GitHub repository. If NULL (the default), the reference is determined by the URL field in the DESCRIPTION file.

Value

badge in markdown syntax

Author(s)

Matt Schuelke

badge_github_version

Description

badge of devel version

Usage

badge_github_version(pkg = NULL, color)

Arguments

pkg

package. If NULL (the default) the package is determined via the DESCRIPTION file.
color

badge color

Value

badge in markdown syntax

Author(s)

Guangchuang Yu

badge_last_commit

Description

last commit badge

Usage

badge_last_commit(ref = NULL, branch = NULL)

Arguments

ref

Reference for a GitHub repository. If NULL (the default), the reference is determined by the URL field in the DESCRIPTION file.
branch

The GitHub branch. If NULL (the default), the default branch is automatically determined.

Value

badge in markdown syntax

Author(s)

Gregor de Cillia

License badge

Description

License badge

Usage

badge_license(license = NULL, color = "blue", url = NULL)

Arguments

license

The license to use. If NULL (the default), the license is determined via the DESCRIPTION file.
color

badge color
url

The URL of the LICENSE text. If NULL (the default), links to the CRAN Package License page. This leads to a broken link if package uses a non-CRAN compatible license.

Value

badge in markdown syntax

Author(s)

Alexander Rossell Hayes

badge_lifcycle

Description

lifecycle badge

Usage

badge_lifecycle(stage = "experimental", color = NULL)

Arguments

stage

lifecycle stage See https://lifecycle.r-lib.org/articles/stages.html
color

color of the badge. If missing, the color is determined by the stage.

Value

badge in markdown syntax

Author(s)

Gregor de Cillia, Waldir Leoncio

badge_repostatus

Description

repostatus.org badge

Usage

badge_repostatus(status, alt = NULL)

Arguments

status

project status (Concept, WIP, Suspended, Abandoned, Active, Inactive, Unsupported, Moved). See https://www.repostatus.org/lifecycle for more details.
alt

Alternative text

Value

badge in markdown syntax

Author(s)

Waldir Leoncio

r-universe badge

Description

r-universe badge

Usage

badge_runiverse(pkg = NULL, user = NULL)

Arguments

pkg

Package name. If NULL (the default), the name is determined by the URL field in the DESCRIPTION file.
user

User name. If NULL (the default), the name is determined by the URL field in the DESCRIPTION file.

Value

badge in markdown syntax

Author(s)

Alexander Rossell Hayes

badge_sci_citation

Description

SCI citation badge

Usage

badge_sci_citation(url, color)

Arguments

url

Web of Science url
color

color of badge

Value

badge in markdown syntax

Author(s)

Guangchuang

badge_travis

Description

travis-ci badge

Usage

badge_travis(ref = NULL, is_commercial = FALSE, branch = NULL)

Arguments

ref

Reference for a GitHub repository. If NULL (the default), the reference is determined by the URL field in the DESCRIPTION file.
is_commercial

Flag to indicate whether or not to use https://travis-ci.com
branch

The GitHub branch. If NULL (the default), the default branch is automatically determined.

Value

badge in markdown syntax

Author(s)

Gregor de Cillia

gitaward

Description

git award rank

Usage

gitaward(user = "guangchuangyu", lang)

Arguments

user

user
lang

language

Value

rank

Author(s)

Guangchuang Yu

ver_devel

Description

get devel version number of specific package

Usage

ver_devel(pkg = NULL)

Arguments

pkg

package. If NULL (the default) the package is determined via the DESCRIPTION file.

Value

devel version

Author(s)

Guangchuang