aemo (version 0.4.3)

aemo_snapshot: Snapshot provenance for an aemo_tbl

Description

Returns a one-row-per-source provenance record for an aemo_tbl, suitable for inclusion in a paper appendix, a Zenodo deposit, or a CRAN-style data manifest. The snapshot captures:

Usage

aemo_snapshot(x)

Value

A data frame with one row per table.

Arguments

x

An aemo_tbl (or a list of them).

Details

• title: the human-readable title of the table;

• source: the NEMweb / MMSDM URL family the table was drawn from;

• licence: the AEMO Copyright Permissions Notice (always);

• retrieved: the POSIXct timestamp at which the table was constructed;

• rows, cols: observed dimensions;

• sha256: a SHA-256 digest of the table's printed body, stable across R versions and platforms.

The sha256 column is what makes the snapshot pinnable: if the same query returns a different hash, the underlying data has changed (or the row-order has, which is also worth knowing). Pair with a git commit of the analysis script to give a reader a closed reproducibility loop.

See Also

Other reference: aemo_dlf(), aemo_interconnectors(), aemo_mlf(), aemo_participants(), aemo_price_caps(), aemo_regions(), aemo_settlement(), aemo_units()

Examples

x <- structure(
  data.frame(settlementdate = Sys.time(), region = "NSW1", rrp = 80),
  aemo_title = "Demo",
  aemo_source = "https://nemweb.com.au",
  aemo_licence = "AEMO Copyright Permissions Notice",
  aemo_retrieved = Sys.time(),
  class = c("aemo_tbl", "data.frame")
)
aemo_snapshot(x)