alval_badges: Add Continuous Integration Badges

Description Usage Arguments Value Examples

View source: R/alval_badges.R

Description

Add continuous integration services to the R package. Additionally provide badges to your GitHub page to place in the readme.

Usage

1
2
3
4
5
6
7
8
9
alval_badges(
  pkg_path = NULL,
  gh_username = NULL,
  interactive = TRUE,
  travis = TRUE,
  coverage = TRUE,
  appveyor = TRUE,
  cran = TRUE
)

Arguments

pkg_path

The path to your package

gh_username

Your GitHub username

interactive

TRUE by default opens web browse to the continuous integration site to activate. FALSE will not open browser.

travis

TRUE by default adds .travis.yml to the top level directory and opens travis for configuration

coverage

TRUE by default adds coverage reports to a package that is in Travis CI

appveyor

TRUE by default adds a basic appveyor.yml to the top level of a package and opens AppVeyor CI.

cran

TRUE by default adds cran badge for cran version or not on cran if not on cran

Value

Tibble with badges based on user inputs. If not input FALSE will be returned.

Examples

1
2
3
4
5
6
7
8
## Not run: 
badges = alval_ci(pkg_path = '/Users/alval/Box/Research/aliviateR',
                  gh_username = 'avalcarcel9',
                  coverage = FALSE)
badges$travis_badge
badges$coverage_badge
badges$appveyor_badge
## End(Not run)

avalcarcel9/aliviateR documentation built on July 10, 2020, 12:32 p.m.