README.md

In krlmlr/tic.packagedocs: Example Package for 'tic'

tic.packagedocs

A minimal example package with packagedocs documentation created and uploaded by tic. The documentation is written 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.

Differences to a conventional CI setup

Only a few files need to be 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.
• appveyor.yml: This file translates between CI stages of AppVeyor and tic stages.
• .Rbuildignore: The listed files should not be part of the R package building process and must be excluded.

Set up an operational fork of this repository

If you want to experiment with travis and tic for a packagedocs project, 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 a lot of 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 tic::use_tic() to set up all requirements needed for the CI integration of your package.

krlmlr/tic.packagedocs documentation built on Jan. 21, 2020, 4:16 p.m.