https://github.com/robinlovelace/afrimapr-book

https://github.com/robinlovelace/afrimapr-book

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/robinlovelace/afrimapr-book
• Owner: Robinlovelace
• License: cc0-1.0
• Created: 2020-01-09T13:16:23.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-01-09T13:16:37.000Z (over 5 years ago)
• Last Synced: 2025-04-03T16:12:19.500Z (about 2 months ago)
• Language: CSS
• Size: 264 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tic.bookdown

[![Travis build status](https://travis-ci.org/ropenscilabs/tic.bookdown.svg?branch=master)](https://travis-ci.org/ropenscilabs/tic.bookdown)

[![Build status](https://ci.appveyor.com/api/projects/status/uqjyx4mrksnul9en/branch/master?svg=true)](https://ci.appveyor.com/project/ropensci/tic-bookdown/branch/master)

[![Coverage Status](https://codecov.io/gh/ropenscilabs/tic.bookdown/branch/master/graph/badge.svg)](https://codecov.io/github/ropenscilabs/tic.bookdown?branch=master)

This is a minimal example of a book based on R Markdown and **bookdown** (https://github.com/rstudio/bookdown), built and deployed by _tic_. 

_tic_ is an R package for CI-agnostic workflow definitions for various R projects. 

See its [documentation](https://ropenscilabs.github.io/tic/) 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`](tic.R): This file describes the CI workflow.

- [`.travis.yml`](.travis.yml): This file translates between CI stages of Travis CI and _tic_ stages.

- [`appveyor.yml`](appveyor.yml): This file translates between CI stages of AppVeyor and _tic_ stages.

- [`.Rbuildignore`](.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 _bookdown_ 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](http://happygitwithr.com/ssh-keys.html) 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). 

1. Run `tic::use_tic()` to set up all requirements needed for the CI integration of your package.

## Accessing the rendered book

The rendered version of the book lives in the `gh-pages` branch (which will be automatically created if missing) and is served via _Github Pages_ using the following URL scheme: `https://.github.io/`.