use_data_doc(
name,
prefix = "doc_",
description = "Description",
source = "Source",
overwrite = FALSE
)
Arguments
- name
Name of the dataset (without extension).
- prefix
Prefix for the generated R file.
- description
Description shown in the roxygen block.
- source
Source attribution shown in the roxygen block.
- overwrite
If FALSE (default), error when the doc file already
exists.
Value
Invisibly, the path of the generated file.