inflate: Inflate Rmd to package

View source: R/inflate.R

inflateR Documentation

Inflate Rmd to package

Description

Inflate Rmd to package

Usage

inflate(
  pkg = ".",
  flat_file,
  vignette_name = "Get started",
  open_vignette = TRUE,
  check = TRUE,
  document = TRUE,
  overwrite = "ask",
  ...
)

Arguments

pkg

Path to package

flat_file

Path to Rmarkdown file to inflate

vignette_name

Character. Title of the resulting vignette. Use NA if you do not want to create a vignette.

open_vignette

Logical. Whether to open vignette file at the end of the process

check

Logical. Whether to check package after Rmd inflating

document

Logical. Whether to document your package using att_amend_desc

overwrite

Logical (TRUE, FALSE) or character ("ask", "yes", "no). Whether to overwrite vignette and functions if already exists.

...

Arguments passed to rcmdcheck::rcmdcheck(). For example, you can do inflate(check = TRUE, quiet = TRUE), where quiet is passed to rcmdcheck::rcmdcheck().

Value

Package structure. Return path to current package.

Examples

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

# {fusen} steps
dev_file <- add_flat_template(template = "full", pkg = dummypackage, overwrite = TRUE)
flat_file <- dev_file[grepl("flat", dev_file)]
fill_description(pkg = dummypackage, fields = list(Title = "Dummy Package"))
inflate(
  pkg = dummypackage, flat_file = flat_file,
  vignette_name = "Exploration of my Data", check = FALSE
)

# Explore directory of the package
# browseURL(dummypackage)

# Try pkgdown build
# usethis::use_pkgdown()
# pkgdown::build_site(dummypackage)
# Delete dummy package
unlink(dummypackage, recursive = TRUE)

fusen documentation built on Sept. 29, 2022, 5:14 p.m.