Skip to main content

Snakemake Conventional Commits

Please note: This plugin is work in progress and NOT ready to use.

Its intention:

  • users will be enabled to automatically create a nanopub using a workflow's metadata
  • this nanopub can subsequently be referenced in publications and thereby covering all metadata necessary to scrutinize an analysis (all too often crucial data are missing from publications)

CLI: plot nanopub knowledge graph

After installation, run:

plot-nanopub-knowledge-graph \
	--dataset-nanopub-id <dataset_nanopub_url> \
	--workflow-nanopub-id <workflow_nanopub_url> \
	--workflow-configuration-id <workflow_configuration_nanopub_url> \
	--report-nanopub-id <report_nanopub_url> \
	-o graph.png

This generates a Graphviz plot with four rounded boxes (Dataset, Workflow, Workflow Configuration, Workflow Report) and arrows labeled used by, used this configuration, produces, and based upon.

Optional settings:

  • --line-color "dark brick red" (default) for node border and arrow color
  • --format svg|png|pdf to override output format
  • --verbose to print debug logs for nanopub description extraction
  • --text-width 60 to control line wrapping width in box text

When the output format resolves to svg (via --format svg or an .svg output filename), Graphviz is invoked with svg:cairo so text is embedded as vector outlines. This avoids downstream font substitution/reflow issues during JOSS LuaLaTeX typesetting.

Default output format is png.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

snakemake_report_plugin_nanopub-0.3.2.tar.gz (132.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

snakemake_report_plugin_nanopub-0.3.2-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file snakemake_report_plugin_nanopub-0.3.2.tar.gz.

File metadata

File hashes

Hashes for snakemake_report_plugin_nanopub-0.3.2.tar.gz
Algorithm Hash digest
SHA256 6094bef369e964041fb763eeff4a5e731415c9977db9239af05189bf67e80180
MD5 36f49ceb5aef253450c49eb05bf3e097
BLAKE2b-256 3010d81f1f875b6d25a1ab6a4069e8f3fc5511941c8d2dc651e44d3e6946bf4a

See more details on using hashes here.

File details

Details for the file snakemake_report_plugin_nanopub-0.3.2-py3-none-any.whl.

File metadata

File hashes

Hashes for snakemake_report_plugin_nanopub-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d9e26bae5fd2a30872565c5893d9eef979ad2dc88aef183520bfaa87cab6d42f
MD5 54397ee38fda03017a89d39ad33131fb
BLAKE2b-256 4ea5e2b8bb6093bd6fa56ade5d3a4d1964de76458266c4f5128351089674321d

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.3.2 This release

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page