Description Usage Arguments Value Examples
Add continuous integration services to the R package. Additionally provide badges to your GitHub page to place in the readme.
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
)
|
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 |
Tibble with badges based on user inputs. If not input FALSE will be returned.
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)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.