Generate a roxygen skeleton for a dataset — fix_dataset_doc • checkhelper

Writes R/{prefix}{name}.R with a roxygen documentation skeleton for the data/{name}.rda dataset. Wraps use_data_doc().

fix_dataset_doc(
  name,
  pkg = ".",
  prefix = "doc_",
  description = "Description",
  source = "Source",
  overwrite = FALSE
)

Arguments

name: Name of the dataset (without extension).
pkg: Path to the package.
prefix: Prefix for the generated R file. Defaults to "doc_".
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. Set TRUE to regenerate it in place.

Value

Invisibly, the path of the generated file.

See also

audit_dataset_doc(), use_data_doc().

Examples

if (FALSE) { # \dontrun{
fix_dataset_doc("my_data", description = "My data", source = "Internal")
} # }