inflate | R Documentation |
Inflate Rmd to package
inflate( pkg = ".", flat_file, vignette_name = "Get started", open_vignette = TRUE, check = TRUE, document = TRUE, overwrite = "ask", ... )
pkg |
Path to package |
flat_file |
Path to Rmarkdown file to inflate |
vignette_name |
Character. Title of the resulting vignette.
Use |
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 |
overwrite |
Logical (TRUE, FALSE) or character ("ask", "yes", "no). Whether to overwrite vignette and functions if already exists. |
... |
Arguments passed to |
Package structure. Return path to current package.
# 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)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.