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.2.0.tar.gz (131.1 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.2.0.tar.gz.

File metadata

File hashes

Hashes for snakemake_report_plugin_nanopub-0.2.0.tar.gz
Algorithm Hash digest
SHA256 ecc21bd0b30dd71a3ad9bdf5ebceef1e849b7276291e92ee221bdd42813461b5
MD5 d63801631ee1a71068a54c60288aa7a4
BLAKE2b-256 e94c5017103077f295fe66b011157668f4b89c5585ead931dd450d78675ed610

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for snakemake_report_plugin_nanopub-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e1dff0fcd05514cbb3e84b0ca36b60ed3fe4420410b867a7a032b3fd8b21440c
MD5 cf9b5328c1cc192bb78176c79b6d7ee0
BLAKE2b-256 2a0fce0471fb613cee0f10cf9933b7625af3908fc52954bac955ba4de22a426d

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