snakemake.report package¶
Module contents¶
- class snakemake.report.EmbeddedFigure(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶
Bases:
docutils.parsers.rst.directives.images.Figure
,snakemake.report.EmbeddedMixin
- class snakemake.report.EmbeddedImage(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶
Bases:
docutils.parsers.rst.directives.images.Image
,snakemake.report.EmbeddedMixin
- class snakemake.report.EmbeddedMixin[source]¶
Bases:
object
Replaces the URI of a directive with a base64-encoded version.
Useful for embedding images/figures in reports.
- class snakemake.report.FileRecord(path, job, caption, env, category, workflow, wildcards_overwrite=None, mode_embedded=True, aux_files=None, name_overwrite=None)[source]¶
Bases:
object
- property filename¶
- property icon¶
- property is_img¶
- property is_table¶
- property is_text¶
- property is_vega¶
- property name¶
- property png_content¶
- class snakemake.report.RuleRecord(job, job_rec)[source]¶
Bases:
object
- property code¶
- property input¶
- property output¶
- snakemake.report.data_uri(data, filename, encoding='utf8', mime='text/plain')[source]¶
Craft a base64 data URI from file with proper encoding and mimetype.
- snakemake.report.data_uri_from_file(file, defaultenc='utf8')[source]¶
Craft a base64 data URI from file with proper encoding and mimetype.