You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/docs/embedding.rst
+47-2Lines changed: 47 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,8 +8,53 @@ Alignoth produces fully self-contained HTML files that can be easily embedded in
8
8
This allows users to integrate alignment visualizations directly into existing analysis pipelines, documentation,
9
9
or automated reporting systems such as Snakemake or Datavzrd.
10
10
11
-
Below we demonstrate how to embed Alignoth visualizations within a Snakemake report.
12
-
Additional examples for Datavzrd and other tools will be added in future updates.
11
+
Below we demonstrate how to embed Alignoth visualizations within a Datavzrd and Snakemake report.
12
+
13
+
Embedding in Datavzrd
14
+
=====================
15
+
16
+
`Datavzrd <https://datavzrd.github.io>`_ allows embedding Vega-Lite plots via its `render-plot` keyword.
17
+
This enables embedding one or more Alignoth plots directly into a Datavzrd report.
18
+
These views (e.g. per variant or gene of interest) can be linked to an overview table via Datavzrd's `linking feature <https://datavzrd.github.io/docs/configuration.html#links>`_.
19
+
Technically embedding the alignment views can be achieved by calling Alignoth asking for a tsv formatted output using `-f tsv` and an output directory `-o output/` for the datasets and Vega-Lite spec files like this:
0 commit comments