Add dev_history.Rmd file that drives package development

Source: R/add_dev_history.R

add_dev_history() is deprecated. We will soon be totally switching to add_flat_template(), which is more consistent with development processes

add_dev_history(name = "teaching") is equivalent to add_flat_template(template = "teaching")

add_dev_history(
  pkg = ".",
  overwrite = FALSE,
  open = TRUE,
  dev_dir = "dev",
  name = c("full", "minimal", "additional", "teaching")
)

Arguments

pkg

Path where to save file

overwrite

Whether to overwrite existing dev_history.Rmd file

open

Logical. Whether to open file after creation

dev_dir

Name of directory for development Rmarkdown files. Default to "dev".

name

Name of the template file. See add_flat_template()

Value

Create flat Rmd file(s) and return its (their) path

Examples

# Create a new project
dummypackage <- tempfile("dummypackage")
dir.create(dummypackage)

# Add - Use `add_flat_template()` instead
add_flat_template(template = "teaching", pkg = dummypackage)
#> Created file .here in /tmp/Rtmp3Vk9Ap/dummypackage3f5844c057ae . Please start a new R session in the new project directory.
#> [1] "/tmp/Rtmp3Vk9Ap/dummypackage3f5844c057ae/dev/flat_teaching.Rmd"

# Delete dummy package
unlink(dummypackage, recursive = TRUE)