This function creates a document, defined by a listdown bundle in a specified location on disk and, optionally, opens the document in the browser.
ld_create_doc( ldb, rmd_file_name = basename(tempfile(pattern = "rmarkdown", fileext = ".rmd")), rmd_dir = file.path(tempdir(), "rmarkdown"), output_dir = file.path(rmd_dir, "pres"), render_doc = TRUE, cc_file_name = NULL, data_dir = NULL, view = interactive(), ... )
| ldb | a listdown doc bundle. |
|---|---|
| rmd_file_name | the name of the R Markdown file to create. By default, a temporary file is created. |
| rmd_dir | the directory where the output R Markdown file should be written to. By default, this is `tempdir()`. |
| output_dir | the location of the rendered document, relative to the directory specified by `rmd_dir`. Note that this is an rmarkdown convention. By default a directory names "pres" is created in the directory specified by `rmd_dir` and rendered documents are place there. |
| render_doc | should the page be rendered? If not then the `output_dir` is not created. |
| cc_file_name | the name of the list specifying the computational components. If this is `NULL` (the default) then the listdown bundle is checked to make sure it's `load_cc_expr` attribute has been specified. If it is specified, and the bundles `load_cc_expr` has not been specified, then it will be written to disk (in the corresponding data directory, specified by `data_dir`) and read via the `saveRDS()` function. |
| data_dir | the directory where data should be written. If the `cc_file_name` argument is `NULL` then this argument is ignored. If the `cc_file_name` argument is specfied but `data_dir` is not, then `tempdir()` is used. |
| view | should the output document be opened after rendering? By default, if `render_doc` is `TRUE` and this argument is `TRUE` then the browser will open for you to examine the output. |
| ... | options to send to the rmarkdown::render() function. |
ld_bundle_doc