workflow_summary: Get workflow summary for this set of reports

View source: R/workflows.R

workflow_summaryR Documentation

Get workflow summary for this set of reports

Description

This includes info on execution order of reports and any dependencies between them and details of any missing dependencies.

Usage

workflow_summary(path, reports, ref = NULL)

Arguments

path

Path to orderly root.

reports

List of reports to get workflow summary for, this must be at a minimum a list of lists each item containing "name" property of the report name. It can have additional data too but this is ignored for checking dependencies.

Details

Report A has a missing dependency if, report A has a "depends" block in its 'orderly.yml' which depends on latest version (or latest with some search term) of report B and report B does not occur in the list of reports.

Value

List containing reports in the order they will be queued including info about any dependencies between them. Also a list with key report name and value is any missing dependencies for that report.


vimc/orderly.server documentation built on July 27, 2023, 5:07 p.m.