Skip to main content

Reporter plugin for Snakemake using nanopub-py to create workflow metadata nanopubs

Project description

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.

Project details


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.0.tar.gz (131.9 kB view details)

Uploaded Source

Built Distribution

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

File details

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

File metadata

File hashes

Hashes for snakemake_report_plugin_nanopub-0.3.0.tar.gz
Algorithm Hash digest
SHA256 ea5623c2412448d4fc4ad762d6b763ee1ad402c78b781756a8d1c012dc4036e0
MD5 8834c65b4769aa5d672d95bef3447159
BLAKE2b-256 3f271fa54b295a9561fe262b87a77ffcd812d9743777e02b0903e1988bec05d5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for snakemake_report_plugin_nanopub-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4698583d4d02699c308cc05c0720cc7dc33355bb23c88410a4b69cff4a194867
MD5 f00d74885a5654be7e26cb329d1a0b10
BLAKE2b-256 5f9499958b7ab632196013fd5baae5b531612c3a4aa7fa7ab98bd64150e794d8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page