Skip to contents

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)
#> $started_at
#> [1] "2024-01-27 09:00:53 GMT"
#> 
#> $ended_at
#> [1] "2024-01-27 09:00:53 GMT"
#> 
#> $wasAssocitatedWith
#> [1] "doi:10.5281/zenodo.10473154"
#> 
#> $wasInformedBy
#> [1] "https://doi.org/10.1111/j.1469-1809.1936.tb02137.x"
#> 

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