set_package: Set package metadata

In ezwelty/dpkg: Data Packages for R

Description

New properties are added and existing properties are replaced (or deleted if NULL). If set, properties override the defaults returned by get_package.

Usage

set_package(.data, name, title, description, homepage, id, profile, version,
  created, sources, contributors, licenses, keywords, image, resources, ...)

set_package(.data) <- value

Arguments

.data	Object to modify (typically a list of data.frames).
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.
value	(named list) Package metadata (typically a call to package).

See Also

Other package functions: package

Examples

x <- set_package(
  list(data = data.frame(id = 1L, value = 1.1)),
  title = "Example data package"
)
get_package(x)
x <- list(data = data.frame(id = 1L, value = 1.1))
set_package(x) <- package(title = "Example data package")
get_package(x, inline_data = FALSE)

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