use-notestar: Create a brand new notebook with default settings

In tjmahr/tarnotes: Notebooks Using 'Targets' and 'Bookdown'

Create a brand new notebook with default settings

Description

Create a brand new notebook with default settings

Usage

use_notestar(
  dir_project = ".",
  dir_notebook = "notebook",
  dir_md = "notebook/book",
  notebook_helper = "knitr-helpers.R",
  cleanrmd_theme = "water",
  notebook_filename = "notebook",
  open = interactive()
)

use_notestar_makefile(dir_project = ".")

use_notestar_references(dir_project = ".")

Arguments

dir_project	file-path to the base/root folder of the project. Defaults to "." which is the current working directory.
dir_notebook	Name of the directory containing the Rmd files. It should be a relative path from the project root. Defaults to "notebook"
dir_md	Name of the directory to contain md files (knitted Rmd files). It should be a relative path from the project root. Defaults to "notebook/book".
notebook_helper	Filename for an R script to run before knitting each Rmd file and rendering the notebook with bookdown. The file must be in dir_md. Defaults to "knitr-helpers.R" so the default location is ⁠"notebook/knitr_helpers.R⁠.
cleanrmd_theme	Theme to use for cleanrmd::html_document_clean(). Defaults to "water".
notebook_filename	Name to use for the final html file. Defaults to "notebook" which produces "notebook.html".
open	whether to open ⁠_targets.R⁠, notebook/index.Rmd, and R/functions.R when they are created. Defaults to interactive() (whether the code is being called interactively).

Value

use_notestar_makefile() creates a Makefile that will build or clean a targets-based workflow.

use_notestar_references() adds the files "refs.bib" and "apa.csl" to dir_notebook.

tjmahr/tarnotes documentation built on Jan. 27, 2025, 2:17 a.m.