create_vignette_last_modif {gitdown} | R Documentation |
Creates and updates a vignette in the 'vignette/' directory of a package with last modification time of tracked files
Description
Creates and updates a vignette in the 'vignette/' directory of a package with last modification time of tracked files
Usage
create_vignette_last_modif(
repo = ".",
path = "R",
recursive = TRUE,
untracked = TRUE
)
update_vignette_last_modif(
repo = ".",
path = "R",
recursive = TRUE,
untracked = TRUE
)
Arguments
repo |
git repository |
path |
Default to R folder. Use "" for the complete directory |
recursive |
Logical. Should the listing recurse into directories? |
untracked |
Logical. Should the not tracked files be included? |
Value
No return value, called for side effect. Creates and updates the content of the "modification_files.Rmd" vignette
Examples
# Creates vignette
repo <- fake_repo(as.package = TRUE)
if (rmarkdown::pandoc_available("2.0.0")) {
create_vignette_last_modif(repo, path = "R")
}
# update vignette
repo <- fake_repo(as.package = TRUE)
if (rmarkdown::pandoc_available("2.0.0")) {
update_vignette_last_modif(repo, path = "R")
rmarkdown::render(file.path(repo, "vignettes", "modification_files.Rmd"))
}
[Package gitdown version 0.1.6 Index]