checkhelper (version 0.1.1)

use_data_doc: Create documentation of a rda / RData dataset in a package

Description

Create documentation of a rda / RData dataset in a package

Usage

use_data_doc(
  name,
  prefix = "doc_",
  description = "Description",
  source = "Source"
)

Value

Creates a data documentation in a R file and returns path to the file

Arguments

name

Name of your data without extension

prefix

Add prefix for the name of the output R script

description

Description of the dataset that will be added in the documentation

source

Source of the dataset that will be presented in the documentation

See Also

get_data_info() to only retrieve information without writing the documentation

Examples

if (FALSE) {
# This adds a R file in the current user directory
# This works if there is a "my_data.rda" file in your "data/" directory
use_data_doc("my_data", description = "Description of my_data", source = "Here the source")
}