package: Create package metadata

In ezwelty/dpkg: Data Packages for R

Description

The metadata for a data package. See set_package and get_package to set and get package metadata to and from an object.

Usage

package(name = NULL, title = NULL, description = NULL, homepage = NULL,
  id = NULL, profile = NULL, version = NULL, created = NULL,
  sources = list(), contributors = list(), licenses = list(),
  keywords = NULL, image = NULL, resources = list(), ...)

Arguments

name	(character) Package name.
title	(character) Human-readable title.
description	(character) Human-readable description.
homepage	(character) URL of the package homepage.
id	(character) Globally unique identifier.
profile	(character) Package profile (see https://specs.frictionlessdata.io/profiles/).
version	(character) Version specification (see http://semver.org/).
created	(character) ISO 8601 date and time of package creation (see https://tools.ietf.org/html/rfc3339#section-5.6).
sources	(list) See source.
contributors	(list) See contributor.
licenses	(list) See license.
keywords	(character) Keywords describing the package.
image	(character) URL or path relative to the package directory (see data-resource/url-or-path).
resources	(list) See resource.
...	(name = value) Additional properties.

Details

TODO:

• Require name?

• Name must be lower-case and contain only alphanumeric characters and ., _, and -.

References

https://specs.frictionlessdata.io/data-package/

See Also

Other meta objects: constraints, contributor, field, foreignKey, resource, schema, source

Other package functions: set_package

Examples

package(
 name = "example",
 title = "Example data package"
)

ezwelty/dpkg documentation built on May 30, 2019, 7:19 a.m.