Append a provenance step, capturing an optional seed

A thin convenience over logStep that records an append-only provenance entry on the object's metadata log (never dropping prior entries), optionally capturing an integer seed in the entry parameters so the step is reproducible under a fixed seed.

Usage

addProvenance(
  pe,
  step,
  params = list(),
  seed = NULL,
  package = NA_character_,
  version = NA_character_
)

Arguments

pe

A PhysioExperiment object.

step

Character step / activity name.

params

Named list of parameters recorded with the step.

seed

Optional integer seed captured in the entry parameters.

package, version

Optional producing-package name and version.

Value

pe with the entry appended to its provenance log.

See also

logStep, provenance

Examples

pe <- PhysioExperiment(
  S4Vectors::SimpleList(raw = matrix(rnorm(20), 10, 2)), samplingRate = 100)
pe <- addProvenance(pe, "conformalInterval", seed = 42)
provenance(pe)
#>                step          activity
#> 1 conformalInterval conformalInterval
#>                                         entity used generated
#> 1 pe:conformalInterval@2026-08-25T15:52:53.375 <NA>      <NA>
#>                  agent   user package version       startedAtTime
#> 1 runner@runnervm76f27 runner    <NA>    <NA> 2026-08-25 15:52:53
#>           endedAtTime           timestamp  params params_json
#> 1 2026-08-25 15:52:53 2026-08-25 15:52:53 seed=42 {"seed":42}