Skip to contents

Record an analysis step in the provenance log

Source: R/provenance.R
logStep.Rd

Appends a timestamped, agent-attributed PROV activity. Call this from any operation that returns a modified PhysioExperiment.

Usage

logStep(
  x,
  step,
  params = list(),
  package = NA_character_,
  version = NA_character_
)

Arguments

x

A PhysioExperiment.

step

Character scalar naming the operation (e.g. "filterSignals").

params

Named list of parameters to record.

package, version

Optional originating package name and version.

Value

x with the step appended (the input is unchanged; a modified copy is returned).

Examples

pe <- PhysioExperiment(
  S4Vectors::SimpleList(raw = matrix(rnorm(20), 10, 2)), samplingRate = 100)
pe <- logStep(pe, "filterSignals", params = list(low = 1, high = 40))
provenance(pe)
#>            step      activity                                   entity used
#> 1 filterSignals filterSignals pe:filterSignals@2026-08-25T15:53:04.852 <NA>
#>   generated                agent   user package version       startedAtTime
#> 1      <NA> runner@runnervm76f27 runner    <NA>    <NA> 2026-08-25 15:53:04
#>           endedAtTime           timestamp         params         params_json
#> 1 2026-08-25 15:53:04 2026-08-25 15:53:04 low=1, high=40 {"low":1,"high":40}