Description Usage Arguments Value Examples
Create dataset descriptions for roxygen. The workhorse.
1 2 3 4 |
data |
Input data |
text |
Optional text describing dataset (to go in description area). |
file |
Optional location of file with description of data |
outfile |
Optional location of file to write output |
fileEncoding |
File encoding |
envir |
Environment to find data |
encoding |
encoding |
comment.char |
prefix character for roxygen template (default ) |
start |
Start of itemized list (default "\\itemize {") |
end |
End of itemized list (default "}") |
item |
Format for an item in list as regex to pass to sprintf. |
indent |
How many spaces to indent itemized lists (default: 3) |
sublist |
Optional list of columns (factors/characters) that should be sublisted. |
add_tables |
List of columns to add tabular counts in description (or TRUE for all). |
... |
further arguments passed to roxy_format |
Vector of lines for roxygen metadata, or write to file if outfile
.
1 2 3 4 5 |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.