PHS HTML template (#69)

* PHS HTML template

* copy in CSS file with code

* Update documentation

* tidying

---------

Co-authored-by: Alan Yeung <[email protected]>
Co-authored-by: alan-y <[email protected]>

NEWS.md

@@ -2,6 +2,7 @@
 
 * Added three Management information templates for Word documents, accessible through RStudio menu: a Management Info Report, A Management Info Summary, and, a Management Info One Page template.
 * The Management Info One Page template will accommodate using more than one page and applies page numbers from page 2 onwards, so could also be used as a template for a simple information request response.
+* Basic PHS style HTML template.
 * RStudio addin for `add_stylecss()` so users can add a PHS style.css file directly from RStudio.
 
 

R/add_stylecss.R

@@ -3,6 +3,7 @@
 #'
 #' @param path String: path to add phs_style.css file. If left blank, RStudio will prompt the user.
 #' @param shinycss Logical: Whether to append shiny CSS code to the file (TRUE) or not (FALSE). If left blank, RStudio will prompt the user.
+#' @param auto_open Logical: Automatically open the phs_style.css after it is compiled?
 #'
 #' @return NULL - Adds phs_style.css file to the directory.
 #' @export
@@ -11,7 +12,7 @@
 #' add_stylecss()
 #' }
 add_stylecss <- function(path = rstudioapi::selectDirectory(caption = "Select folder to add phs_style.css"),
-                         shinycss = FALSE) {
+                         shinycss = FALSE, auto_open = TRUE) {
   if (is.null(path)) {
     message("phs_style.css file not added.")
     return(invisible(NULL))
@@ -54,6 +55,10 @@ add_stylecss <- function(path = rstudioapi::selectDirectory(caption = "Select fo
 
   writeLines(stylecss, con = file.path(path, "phs_style.css"))
   message(paste("phs_style.css has been written to", path))
-  rstudioapi::documentOpen(file.path(path, "phs_style.css"))
+
+  if (auto_open) {
+    rstudioapi::documentOpen(file.path(path, "phs_style.css"))
+  }
+
   return(invisible(NULL))
 }

inst/rmarkdown/templates/phs-html/skeleton/skeleton.Rmd

@@ -0,0 +1,40 @@
+---
+title: "My PHS HTML Document"
+author: "My Name"
+date: "`r format(Sys.Date(), '%d %B %Y')`"
+output: 
+  html_document:
+    css: phs_style.css
+    toc: true
+    toc_float: true
+keep_md: true
+---
+
+```{r setup, include=FALSE}
+knitr::opts_chunk$set(echo = TRUE)
+
+# Copy in the PHS style CSS file if required
+if (!file.exists(file.path(getwd(), "phs_style.css"))) {
+  phstemplates::add_stylecss(getwd(), auto_open = FALSE)
+}
+```
+
+# R Markdown
+
+This is an R Markdown document with basic PHS styles included for output to HTML.
+
+When you click the **Knit** button a document will be generated that includes both content as well as the output of any embedded R code chunks within the document. You can embed an R code chunk like this:
+
+```{r cars}
+summary(cars)
+```
+
+## Including Plots
+
+You can also embed plots, for example:
+
+```{r pressure, echo=FALSE}
+plot(pressure)
+```
+
+Note that the `echo = FALSE` parameter was added to the code chunk to prevent printing of the R code that generated the plot.

inst/rmarkdown/templates/phs-html/template.yaml

@@ -0,0 +1,2 @@
+name: PHS HTML Document
+description: Template to produce a PHS document with basic PHS styles.