Skip to contents

Create a datapackage.json template

Source: R/init_data.R
init_data.Rd

Initialize dataset documentation with a datapackage.json template, based on a Data Package standard.

Usage

init_data(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 data_add.

write

Logical; if FALSE, the package object will not be written to a file.

overwrite

Logical; if TRUE and write is TRUE, an existing datapackage.json file will be overwritten.

quiet

Logical; if TRUE, will not print messages or navigate to files.

Value

An invisible list with the content written to the datapackage.json file.

See also

Add basic information about a dataset with data_add.

Examples

if (FALSE) {
# make a template datapackage.json file in the current working directory
init_data("mtcars", "Motor Trend Car Road Tests")
}