dataset (version 0.3.1)

provenance: Get or update provenance information

Description

Add or update information about the history (provenance) of the dataset.

Usage

provenance(x)
provenance(x) <- value

Arguments

x

An R object that contains the data of the dataset (a data.frame or inherited from data.frame), for example, tibble::tibble(), tsibble::tsibble(), data.table::data.table().

value

A list that may contain the following elements: wasInformedBy, wasAssociatedWith.

Details

For additional details see vignette("provenance", package = "dataset").

Examples

# Get the provenance of a dataset:
provenance(iris_dataset)

# Update the provenance:
provenance(iris_dataset) <- list(
          wasInformedBy="https://doi.org/10.1111/j.1469-1809.1936.tb02137.x"
          )