snakemake.report package

Module contents

class snakemake.report.Category(name)

基类：object

class snakemake.report.ConfigfileRecord(configfile)

基类：object

code()

class snakemake.report.EmbeddedFigure(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

基类：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)

基类：docutils.parsers.rst.directives.images.Image, snakemake.report.EmbeddedMixin

class snakemake.report.EmbeddedMixin

基类：object

Replaces the URI of a directive with a base64-encoded version.

Useful for embedding images/figures in reports.

run()

Image.run() handles most of the

class snakemake.report.FileRecord(path, job, caption, env, category)

基类：object

icon

is_img

is_table

is_text

name

render(env, rst_links, categories, files)

class snakemake.report.JobRecord

基类：object

class snakemake.report.RuleRecord(job, job_rec)

基类：object

add(job_rec)

code()

snakemake.report.auto_report(dag, path)

snakemake.report.data_uri(data, filename, encoding='utf8', mime='text/plain')

Craft a base64 data URI from file with proper encoding and mimetype.

snakemake.report.data_uri_from_file(file, defaultenc='utf8')

Craft a base64 data URI from file with proper encoding and mimetype.

snakemake.report.get_resource_as_string(url)

snakemake.report.mime_from_file(file)

snakemake.report.report(text, path, stylesheet='/home/docs/checkouts/readthedocs.org/user_builds/snakemakecn/envs/latest/lib/python3.7/site-packages/snakemake/report/report.css', defaultenc='utf8', template=None, metadata=None, **files)

snakemake.report.rulegraph_d3_spec(dag)