inst/templates/notebook/plan.R

In tjmahr/usedrake:

# The workflow plan data frame outlines what you are going to do.
plan <- drake_plan(
  data = datasets::iris,

  hist = create_plot(data),
  fit = lm(Sepal.Width ~ Petal.Width + Species, data),

  # bookdown uses yaml configuration files to set options for the package.
  # We want to keep the configuration close to the build workflow, so I have
  # drake create the files using the ymlthis package.
  notebook_output_yaml_data = ymlthis::yml_empty() %>%
    ymlthis::yml_output(
      bookdown::markdown_document2(
        base_format = "cleanrmd::html_document_clean",
        theme = "water",
        toc = TRUE,
        mathjax = "default"
      )
    ) %>%
    ymlthis::yml_chuck("output"),

  notebook_output_yaml_file = yaml::write_yaml(
    notebook_output_yaml_data,
    file_out(!! here::here("notebook/_output.yml"))
  ),

  # Find the chapters and put them in reverse-chronological order
  notebook_rmd_paths = file_in(!! usedrake::notebook_rmd_collate("notebook")),

  # The chapters are configured in the _bookdown.yml file.
  notebook_bookdown_yaml_data = ymlthis::yml_empty() %>%
    ymlthis::yml_bookdown_opts(
      book_filename = "notebook",
      output_dir = "docs",
      delete_merged_file = TRUE,
      new_session = TRUE,
      before_chapter_script = "knitr-helpers.R",
      rmd_files = basename(notebook_rmd_paths),
    ),

  notebook_bookdown_yaml_file = yaml::write_yaml(
    notebook_bookdown_yaml_data,
    file_out(!! here::here("notebook/_bookdown.yml"))
  ),

  notebook = {
    # Tell drake to find and check all the input files of the notebook
    knitr_in( !! usedrake::notebook_rmd_collate("notebook"))
    # file_in(!! here::here("notebook/assets/apa.csl"))
    # file_in(!! here::here("notebook/assets/refs.bib"))
    file_in(!! here::here("notebook/knitr-helpers.R"))
    file_in(!! here::here("notebook/_bookdown.yml"))
    file_in(!! here::here("notebook/_output.yml"))
    rmarkdown::render_site("notebook", encoding = 'UTF-8')
    file_out(!! here::here("notebook/docs/notebook.html"))
  },


  spellcheck_exceptions = c(
    character(0)
  ),

  spellcheck_notebook = spelling::spell_check_files(
    file_in(!! usedrake::notebook_rmd_collate("notebook")),
    ignore = spellcheck_exceptions
  ),

  # Prints out spelling mistakes when any are found
  spellcheck_report_results = target(
    command = print(spellcheck_notebook),
    trigger = trigger(condition = nrow(spellcheck_notebook) > 0)
  ),

)