Take 5.

R/build-site.r

@@ -10,6 +10,27 @@
 #' @param header a `list` with the header information for the document.
 #' @param ld a `listdown` object describing how to present the computational
 #' components.
+#' @examples
+#' library(ggplot2)
+#' cc <- list(
+#'     iris = iris,
+#'      Sepal.Length = list(
+#'        Sepal.Width = ggplot(iris, aes(x = Sepal.Length, y = Sepal.Width)) +
+#'             geom_point(),
+#'        Petal.Length = ggplot(iris, aes(x = Sepal.Length, y = Sepal.Width)) +
+#'             geom_point(),
+#'      Colored = list(
+#'           Sepal.Width = ggplot(iris, aes(x = Sepal.Length, y = Sepal.Width,
+#'             color = Species)) + geom_point(),
+#'           Petal.Length = ggplot(iris, aes(x = Sepal.Length, y = Petal.Length,
+#'             color = Species)) + geom_point())))
+#'
+#' header <- ld_rmarkdown_header("Test header", author = "Some Dude",
+#'                               date = "2020")
+#'
+#' ld <- listdown(package = "ggplot2")
+#'
+#' ld_bundle_doc(cc, header, ld)
 #' @export
 ld_bundle_doc <- function(cc, header, ld) {
   mc <- match.call()

R/chunk-writer.r

@@ -29,6 +29,27 @@
 #' @param ... default options sent to the chunks of the outputted document.
 #' @param chunk_opts a named list of options sent to the chunks of outputted
 #' documents. Note: takes priority over argument provided to ...
+#' @examples
+#' library(ggplot2)
+#' cc <- list(
+#'     iris = iris,
+#'      Sepal.Length = list(
+#'        Sepal.Width = ggplot(iris, aes(x = Sepal.Length, y = Sepal.Width)) +
+#'             geom_point(),
+#'        Petal.Length = ggplot(iris, aes(x = Sepal.Length, y = Sepal.Width)) +
+#'             geom_point(),
+#'      Colored = list(
+#'           Sepal.Width = ggplot(iris, aes(x = Sepal.Length, y = Sepal.Width,
+#'             color = Species)) + geom_point(),
+#'           Petal.Length = ggplot(iris, aes(x = Sepal.Length, y = Petal.Length,
+#'             color = Species)) + geom_point())))
+#' 
+#' header <- ld_rmarkdown_header("Test header", author = "Some Dude",
+#'                               date = "2020")
+#' 
+#' ld <- listdown(package = "ggplot2")
+#' 
+#' ld_bundle_doc(cc, header, ld)
 #' @export
 listdown <- function(package = NULL,
                      decorator = list(),

tests/testthat/test-create-html-site.r

@@ -49,19 +49,19 @@ anscombe_page <- ld_bundle_doc(anscombe_cc, header, ld)
 
 pages <- list(Anscombe = anscombe_page, Iris = iris_page)
 
-site_yaml <- 
-  ld_site_yaml(
-    "Test Site", 
-    tab_name = names(pages),
-    rmd_name = c("index.rmd", "iris.rmd"))
+test_that("Site can be built.", {
+  site_yaml <- 
+    ld_site_yaml(
+      "Test Site", 
+      tab_name = names(pages),
+      rmd_name = c("index.rmd", "iris.rmd"))
 
-site_path <- ld_build_html_site(
-  pages,
-  site_yaml,
-  view = TRUE,
-  quiet = TRUE)
+  site_path <- ld_build_html_site(
+    pages,
+    site_yaml,
+    view = TRUE,
+    quiet = TRUE)
 
-test_that("Site can be built.", {
   expect_equal(basename(site_path), "index.html")
 })