diff plotly_blast_tool/README.md @ 3:82bcfcb60f97 draft default tip

Updated by re-generating with latest ToolFactory so png or html outputs can be requested. Output labels are informative too.
author fubar
date Fri, 04 Aug 2023 01:55:07 +0000
parents 61cc57e069c0
children
line wrap: on
line diff
--- a/plotly_blast_tool/README.md	Wed Jul 26 12:16:56 2023 +0000
+++ b/plotly_blast_tool/README.md	Fri Aug 04 01:55:07 2023 +0000
@@ -1,3 +1,25 @@
 # plotly_blast_tool
 
-Galaxy tool to plot user selected columns from a 25 column Galaxy blastn search output using plotly.express
+## Install to your Galaxy server from the toolshed - search for plotly_blast_tool owned by fubar2
+
+### Example interactive plots and more at https://lazarus.name/demo/
+
+#### Non interactive screen grab of the tool output
+![Plotly tabular non-interactive screengrab](pbsample.png)
+
+Specialised version of the generalised ![plotly_tabular_tool](https://github.com/fubar2/plotly_tabular_tool), but designed
+for 25 column Galaxy blastn search outputs.
+
+It uses the same code, but adds a default header and auto-transformation of the evalue column -log10(x) to make them more like the bitscore
+
+Plotly.express makes a lot of clever design decisions.
+Unfortunately, it gets totally confused with very small floats in scientific notation. Treats columns with 5.00e-204 as strings or something, so
+strange and probably uninformative axes and plots will probably result if you try a blast evalue column without transformation.
+Note that all columns used for colour (legend) and the x/y axis tickmarks are truncated because they can squish up the plot.
+*..* is appended at the truncation.
+
+## Tool made with the Galaxy ToolFactory: https://github.com/fubar2/galaxy_tf_overlay
+The current release includes this and a generic tabular version, plus a java .jar wrapper, in an "advanced example" history 
+where they can be rerun and changed. They are also generated by an "advanced expample workflow"
+where they can be regenerated if the input data sets are available.
+