add_dev_history: Add dev_history.Rmd file that drives package development

Description Usage Arguments Details Value Examples

View source: R/add_dev_history.R

Description

Add dev_history.Rmd file that drives package development

Usage

1
2
3
4
5
6
7
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 details.

Details

Choose name among the different templates available:

Value

Create a dev_history.Rmd file and return its path

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# Create a new project
tmpdir <- tempdir()
dummypackage <- file.path(tmpdir, "dummypackage")
dir.create(dummypackage)

# Add
add_dev_history(pkg = dummypackage)

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

fusen documentation built on Aug. 4, 2021, 5:07 p.m.