View source: R/prepare_design_documentation.R
prepare_design_documentation | R Documentation |
Uses the documentation block of each step to generate a rmarkdown based documentation of your research design.
prepare_design_documentation(
d,
output_file,
title = "Research Design",
code = TRUE,
rmd_header = c("--- ", sprintf("title: \"%s\"", title), sprintf("date: \"%s\"",
Sys.Date()), "output: pdf_document", "---", "")
)
d |
A character vector of the research design steps function names |
output_file |
The file name to store the PDF file to. |
title |
A title string. |
code |
A logical value indicating whether the R code of the design steps should be included in the documentation (defaults to TRUE). |
rmd_header |
The character value containing the header of the rmarkdown file that the function generates. Defaults to a PDF output header |
Output is generated by rmarkdown
and saved to a PDF file, so you need a local rmarkdown
installation
that is capable to produce PDF files.
## Not run:
print("Sorry. No examples yet.")
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.