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

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.1.0.tar.gz (128.7 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.1.0-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for snakemake_report_plugin_nanopub-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d28706497b0e1a53340e220a6aa01ce13306903fbc77796a2425e8488cf7bd09
MD5 3118ac8c1d64e065728435cc5195e186
BLAKE2b-256 d995557b2641ca93599de998dc80476570a8da55d27cae73da3341c4f77a1686

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for snakemake_report_plugin_nanopub-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 29396201355cb89075f354e2f85ec032a19da452cc79670232d6367d6130e3c7
MD5 d3fa604dffe3159c2bfaaa2ace3636f0
BLAKE2b-256 f53bb6868aa5dc474dcd529d4a9e9f17304073f8d85df7cfa10722b81bdf347c

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