prov_wrapup: Wrap up provenance tracking

Description Usage Arguments Examples

Description

This function complets the provenance tracking by capturing the provenance info for the parent script, as well as the session and system info. This is saved to the provenance log file. An optional footer is created (by default) including a brief session/system summary, workflow chart, and table of inputs/outputs. If a footer is desired, this function should be called inside a code chunk with chunk option: results = 'asis'

Usage

1
2
3
prov_wrapup(include_summary = TRUE, include_workflow = TRUE,
  include_table = TRUE, plot_dir = "TD", commit_outputs = FALSE,
  include_header = FALSE, header_level = "#")

Arguments

include_summary

Should a summary of session and system info be included in the rendered Rmd? (default TRUE)

include_workflow

Should a flow chart of the workflow be included in the rendered Rmd? (default TRUE)

include_table

Should an output table be included in the rendered Rmd? (default TRUE)

plot_dir

Direction of workflow plot: 'TD' (default) creates a top-down plot while 'LR' creates a left-right plot.

commit_outputs

Argument passed to script_prov(); create a commit for any new files created during this run? (default FALSE)

include_header

Should a "Provenance" header be included?

header_level

At what Markdown header style should the "Provenance" header be assigned? e.g. '#' = header 1, '##' header 2, etc. Default: '#' (header 1 style)

Examples

1

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