Description Usage Arguments Value Examples
generate documentation for a folder of source files
1 | generateDocs(folder = ".", pattern = "*.R$", fields)
|
|
path to the folder with files to be documented |
|
file name filter |
|
attributes/metadata that should be searched for as a named vector
such as |
a character vector of a markdown table with header based on fields
values
1 2 3 4 | # chunk of a Rmarkdown doc
fields <- c(Title = "Data source", DO = "What the code does", Author = "Author")
tab <- generateDocs(fields = fields)
paste(tab, collapse = "")
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.