wflow_build
builds the website from the files in the analysis
directory. This is intended to be used when developing your code to preview
the changes. When you are ready to commit the files, use
wflow_publish
.
wflow_build( files = NULL, make = is.null(files), update = FALSE, republish = FALSE, view = getOption("workflowr.view"), clean_fig_files = FALSE, delete_cache = FALSE, seed = 12345, log_dir = NULL, verbose = FALSE, local = FALSE, dry_run = FALSE, project = "." )
files | character (default: NULL). Files to build. Only allows files in
the analysis directory with the extension Rmd or rmd. If |
---|---|
make | logical (default: |
update | logical (default: FALSE). Build any files that have been committed more recently than their corresponding HTML files (and do not have any unstaged or staged changes). This ensures that the commit version ID inserted into the HTML corresponds to the exact version of the source file that was used to produce it. |
republish | logical (default: FALSE). Build all published R Markdown
files (that do not have any unstaged or staged changes). Useful for
site-wide changes like updating the theme, navigation bar, or any other
setting in |
view | logical (default: |
clean_fig_files | logical (default: FALSE). Delete existing figure files
for each R Markdown file prior to building it. This ensures that only
relevant figure files are saved. As you develop an analysis, it is easy to
generate lots of unused plots due to changes in the number of code chunks
and their names. However, if you are caching chunks during code
development, this could cause figures to disappear. Note that
|
delete_cache | logical (default: FALSE). Delete the cache directory (if it exists) for each R Markdown file prior to building it. |
seed | numeric (default: 12345). The seed to set before building each
file. Passed to |
log_dir | character (default: NULL). The directory to save log files
from building files. It will be created if necessary and ignored if
|
verbose | logical (default: FALSE). Display the build log directly in the R console as each file is built. This is useful for monitoring long-running code chunks. |
local | logical (default: FALSE). Build files locally in the R console. This should only be used for debugging purposes. The default is to build each file in its own separate fresh R process to ensure each file is reproducible in isolation. |
dry_run | logical (default: FALSE). List the files to be built, without building them. |
project | character (default: ".") By default the function assumes the current working directory is within the project. If this is not true, you'll need to provide the path to the project directory. |
An object of class wflow_build
, which is a list with the
following elements:
files: The input argument files
make: The input argument make
update: The input argument update
republish: The input argument republish
view: The input argument view
clean_fig_files: The input argument clean_fig_files
delete_cache: The input argument delete_cache
seed: The input argument seed
log_dir: The directory where the log files were saved
verbose: The input argument verbose
local: The input argument local
dry_run: The input argument dry_run
built: The relative paths to the built R Markdown files
html: The relative paths to the corresponding HTML files
wflow_build
has multiple, non-mutually exclusive options for deciding
which files to build. In other words, if multiple options are set to
TRUE
, the union of all files will be built. The argument make
is the most useful for interactively performing your analysis. The other
options are more useful when you are ready to publish specific files with
wflow_publish
(which passes these arguments to
wflow_build
).
Files specified via the argument files
are always built.
If make = TRUE
, all files which have been modified more recently
than their corresponding HTML files will be built.
If update = TRUE
, all previously published files which have been
committed more recently than their corresponding HTML files will be built.
However, files which currently have staged or unstaged changes will be
ignored.
If republish = TRUE
, all published files will be rebuilt.
However, files which currently have staged or unstaged changes will be
ignored.
Under the hood, wflow_build
is a wrapper for
render_site
from the package rmarkdown.
if (FALSE) { # Build any files which have been modified wflow_build() # equivalent to wflow_build(make = TRUE) # Build a single file wflow_build("file.Rmd") # Build multiple files wflow_build(c("file1.Rmd", "file2.Rmd")) # Build multiple files using a file glob wflow_build("file*.Rmd") # Build every published file wflow_build(republish = TRUE) # Build file.Rmd and any files which have been modified wflow_build("file.Rmd", make = TRUE) }