script_prov: Assemble script provenance information

Description Usage Arguments Value Examples

Description

This function gathers the information from all provenance tracking within the script and adds system and session info, as well as RDF predicate info.

Usage

1
2
script_prov(script_file = .provEnv$parent_script_file,
  tag = .provEnv$run_tag, commit_outputs = FALSE)

Arguments

script_file

This should be the name of the parent script, to enable a call to git_prov(). The default is .provEnv$parent_script_file as set up in prov_setup().

tag

An optional run tag; defaults to the run tag set in prov_setup().

commit_outputs

Should a git commit be created for the output files? Defaults to FALSE; newly created outputs will show as not git-controlled, while modified outputs will show as changed since last commit.

Value

Returns (invisibly) a named list of characters containing system and session info for the R Markdown knitting session; list includes the following items: run_id, run_hash, run_tag, elapsed_time, memory_use, msg_sys, msg_ses, msg_git, msg_base_pkgs, msg_att_pkgs

Examples

1

oharac/provRmd documentation built on June 25, 2019, 9:06 p.m.