Initialize dataset documentation with a datapackage.json
template, based on a
Data Package standard.
Usage
dcf_datapackage_init(
name,
title = name,
dir = ".",
...,
write = TRUE,
overwrite = FALSE,
quiet = !interactive()
)
Arguments
- name
A unique name for the dataset; allowed characters are
[a-z._/-]
.- title
A display name for the dataset; if not specified, will be a formatted version of
name
.- dir
Directory in which to save the
datapackage.json
file.- ...
passes arguments to
dcf_datapackage_add
.- write
Logical; if
FALSE
, the package object will not be written to a file.- overwrite
Logical; if
TRUE
andwrite
isTRUE
, an existingdatapackage.json
file will be overwritten.- quiet
Logical; if
TRUE
, will not print messages or navigate to files.
See also
Add basic information about a dataset with dcf_datapackage_add
.