use_covrpage | R Documentation |
Adds bash file to execute after Travis test is successfully completed.
use_covrpage( file = ".travis/covrpage.sh", travis_type = c("bash", "pkgdown", "tic"), travis_blocks = c("after_success", "after_failure", "deploy_ghpages"), gh_user = gsub("@(.*?)$", "", system("git config user.email", intern = TRUE)), push_branch = "test", repo = system("git config travis.slug", intern = TRUE), deploy_branch = system("git rev-parse --abbrev-ref HEAD", intern = TRUE) )
file |
character, file path to save bash script to, Default: '.travis/covrpage.sh' |
travis_type |
character, build .travis.yml template for bash script, pkgdown deployment or using the 'tic' package from ropenscilabs on GitHub Default: c('bash','pkgdown','tic') |
travis_blocks |
character, vector that defines what .travis.yml blocks tocreate, Default: c('after_success','after_failure','deploy_ghpages') |
gh_user |
character, Github user name, Default: gsub("@(.*?)$", "", system("git config user.email", intern = TRUE)) |
push_branch |
character, branch Travis will create to push updated covrpage readme file, Default: 'test' |
repo |
character, name of git repo that package is hosted on, Default: system("git config travis.slug", intern = TRUE) |
deploy_branch |
character, name of branch that current package build is located, Default: system("git rev-parse –abbrev-ref HEAD", intern = TRUE) (usually 'master') |
Other setup:
make_badge()
,
tencrypt()
,
use_covrpage_vignette()
use_covrpage(travis_type = 'bash',file=file.path(tempdir(),'myfile.sh')) #does not write to disk use_covrpage(travis_type = 'bash',file=NULL) use_covrpage(travis_type = 'pkgdown') use_covrpage(travis_type = 'pkgdown',travis_block = 'after_success') use_covrpage(travis_type = 'pkgdown',travis_block = 'after_failure') use_covrpage(travis_type = 'pkgdown',travis_block = c('after_success','after_failure'))
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.