inflate: Inflate Rmd to package

In fusen: Build a Package from Rmarkdown Files

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",
  clean = "ask",
  update_params = TRUE,
  codecov = FALSE,
  ...
)

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.
clean	Logical (TRUE, FALSE) or character ("ask", "yes", "no) Whether to delete files that are not anymore created by the current flat file. Typically, if you have deleted or renamed a function in the flat file. Default to "ask".
update_params	Logical. Whether to update the inflate parameters in the configuration file.
codecov	Logical. Whether to compute code coverage with covr::package_coverage().
...	Arguments passed to devtools::check(). For example, you can do inflate(check = TRUE, quiet = TRUE), where quiet is passed to devtools::check().

Value

Package structure. Return path to current package.

See Also

inflate_all() to inflate every flat files according to the configuration file.

Examples

# Create a new project
dummypackage <- tempfile("dummy.package")
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 April 4, 2025, 5:26 a.m.