README.md

DHSC Coding Principles

See the principles HERE.

What is this?

This repository contains a set of R markdown documents which, when rendered produce a bookdown site.

The site contains a set of 10 principles, targeted at the DHSC analytical community, with the aim of raising coding standards across the department. These are based on the MOJ prinicples.

Publishing Process

The code contains build and deploy scripts which are run by travis.

These scripts render the book, and push the rendered files to a gh-pages branch which is then displayed using github pages.

The scripts adapted from the example scripts provided in the bookdown example.

This process means that the book hosted on github pages is kept in sync with the code which produces it without manual intervention.

Ownership

The DHSC Coding Principles are maintained by the Data Science Hub, who sit within the Office of the Chief Analyst Directorate.



DataS-DHSC/coding_principles_book documentation built on March 11, 2020, 4:13 a.m.