shields: Generate the markdown code the a package shields.

In ComputationalProteomicsUnit/cputools: Various helper functions

Description

Functions to generate package travis-ci, codecov, Bioconductor build status and Biocondcutor test coverage shields

Usage

makeTravisShield(pkg, user = options()[["GitHubUserName"]],
  branch = "master")

makeCodecovShield(pkg, user = options()[["GitHubUserName"]],
  branch = "master")

makeBiocBuildShield(pkg, branch = c("devel", "release"))

makeBiocCovrShield(pkg, branch = c("devel", "release"))

Arguments

pkg	Mandatory character with the package name(s). If of length greater than one, then must of of same length as user and branch.
user	Mandatory GitHub username. Default is to retrieve options()[["GitHubUserName"]]. Argument is not recycled of more than one package is provided.
branch	Mandatory branch name. Default is "master". Argument is not recycled of more than one package is provided. For Bioconductor shields (functions makeBiocBuildShield and makeBiocCovrShield), branch is one of "devel" (default) or "release".

Value

Invisibly returns character with the shield in markdown. Used for its side effect of printing the markdown shield.

Author(s)

Laurent Gatto

Examples

makeTravisShield("pRoloc", user = "lgatto")
## default user
options(GitHubUserName = "ComputationalProteomicsUnit")
makeCodecovShield("cputools")
makeCodecovShield("MSnbase", user = "lgatto")
makeBiocBuildShield("MSnbase")
makeBiocBuildShield("MSnbase", branch = "release")
makeBiocCovrShield("MSnbase")
makeBiocCovrShield("MSnbase", branch = "release")

ComputationalProteomicsUnit/cputools documentation built on May 6, 2019, 12:50 p.m.