snakemake.io.report

snakemake.io.report(value, caption=None, category=None, subcategory=None, labels=None, patterns=[], htmlindex=None)

Flag output file or directory as to be included into reports.

In the case of a directory, files to include can be specified via a glob pattern (default: *).

Arguments value – File or directory. caption – Path to a .rst file with a textual description of the result. category – Name of the (optional) category in which the result should be displayed in the report. subcategory – Name of the (optional) subcategory columns – Dict of strings (may contain wildcard expressions) that will be used as columns when displaying result tables patterns – Wildcard patterns for selecting files if a directory is given (this is used as

input for snakemake.io.glob_wildcards). Pattern shall not include the path to the directory itself.