README.md

In metrumresearchgroup/tic.covrpage: Dummy package for tic and covrpage example

tic.covrpage

A minimal example package that creates testing reports with covrpage and deployed by tic.

The report is compiled on the CI and can be deployed to either the master branch or to a development branch. It can also be deployed as a vignette/article to, and served from, the gh-pages branch.

tic is an R package for CI-agnostic workflow definitions for various R projects. See its documentation for more information.

Some things to highlight in the setup of the template.

If the commit is pushed to origin/master then after a successful build covrpage is run and the resulting tests/README.md is deployed back into the origin/master and if there is a vignette output pkgdown will rebuild the docs folder and will be deployed into gh-pages.

If the commit is not pushed to origin/master, ie a origin/<branch>, then after a successful build covrpage is run and the resulting tests/README.md is deployed back into the origin/<branch>.

Comparing to a conventional setup

Only a few files are added or changed to enable integration with tic:

• tic.R: This file describes the CI workflow.
• .travis.yml: This file translates between CI stages of Travis CI and tic stages.
• .Rbuildignore: The files listed above are not part of a built R package and must be excluded.

Set up an operational fork of this repository

If you want to experiment with travis and tic in this repo, you can fork it.

1. Use usethis::create_from_github() to automatically create a fork of this repo. If you use RStudio, a new RStudio project will open. You may need to set up your SSH credentials first. See this guide if you're having problems. (It's definitely worth getting this function running as it saves you so much time in the future!) Alternatively, fork this repo on Github and then create a new R Project within RStudio (File -> New Project -> Version Control -> Github).
2. Run travis::use_tic() to set up all requirements needed for the CI integration of your package.

metrumresearchgroup/tic.covrpage documentation built on May 9, 2019, 10:42 a.m.