Skip to content

Commit 1c54ee8

Browse files
committed
Better docs on the page
1 parent 6ca372a commit 1c54ee8

File tree

1 file changed

+75
-40
lines changed

1 file changed

+75
-40
lines changed

templates/index.html

Lines changed: 75 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -320,21 +320,25 @@ <h1 class="display-4">into <img src="{{url_for('static', filename='images/viz.sv
320320
<h2 id="about">About</h2>
321321

322322
<p>Raw DNA sequences, which consist of long strings of letters, are
323-
hard for humans to make sense of at a glance. However, there is
324-
significant biological meaning contained within them. To reveal this
325-
meaning, <a href="http://squiggle.readthedocs.io/en/latest/methods.html">a number
326-
of methods</a> have been proposed to convert raw DNA sequences into
327-
two-dimensional visualizations. This website allows you to try several
328-
of these methods out on your data with a high-performance
329-
parallel-computing backend enabling genome-scale visualization.</p>
323+
hard for humans to make sense of at a glance. However, there is
324+
significant biological meaning contained within them. To reveal this
325+
meaning, <a
326+
href="http://squiggle.readthedocs.io/en/latest/methods.html">a number
327+
of methods</a> have been proposed to convert raw DNA sequences into
328+
two-dimensional visualizations. This website allows you to try several
329+
of these methods out on your data with a high-performance
330+
parallel-computing backend enabling genome-scale visualization.</p>
330331

331332
<h2 id="instructions">Instructions</h2>
332333

333334
<p>Using this website is easy:</p>
334335

335336
<ol>
336-
<li>Choose a visualization method. For full information about the
337-
visualization methods, take a look <a href="http://squiggle.readthedocs.io/en/latest/methods.html">here</a>.</li>
337+
338+
<li>Choose one or more visualization methods. For full information
339+
about the visualization methods, take a look <a
340+
href="http://squiggle.readthedocs.io/en/latest/methods.html">here</a>.</li>
341+
338342
<li>Upload a sequence by: <ul>
339343
<li>Clicking the "browse" button</li>
340344
<li>Dragging a file anywhere on the page</li>
@@ -343,17 +347,34 @@ <h2 id="instructions">Instructions</h2>
343347
<li>Pasting the contents of a FASTA file into a textbox</li>
344348
</ul>
345349
</li>
350+
346351
</ol>
347352

348353
<p class="font-weight-bold">That's it.</p>
349354

350355
<p>Optionally, after plotting a sequence, you can:</p>
351356

352357
<ul>
353-
<li>Remove files from the visualization by clicking the <i class="fas fa-trash"></i> icon and selecting files</li>
354-
<li>Modify the graph's title and subtitle by clicking the <i class="fas fa-bars"></i> icon</li>
355-
<li>Export the content of the graph in .png, .jpeg, .svg, or .pdf format by clicking on the <i class="fas fa-file-export"></i> icon</li>
356-
<li>Zoom in on a region of interest by clicking and dragging over it, zoom out via the <i class="fas fa-search-minus"></i> icon, or reset the zoom.</li>
358+
359+
<li>Remove files from the visualization by clicking the <i
360+
class="fas fa-trash"></i> icon and selecting files</li>
361+
362+
<li>Modify the graph's title and subtitle by clicking the <i
363+
class="fas fa-bars"></i> icon</li>
364+
365+
<li>Export the content of the graph in .png, .jpeg, .svg, or .pdf
366+
format by clicking on the <i class="fas fa-file-export"></i>
367+
icon</li>
368+
369+
<li>Zoom in on a region of interest by clicking and dragging over
370+
it, zoom out via the <i class="fas fa-search-minus"></i> icon, or
371+
reset the zoom</li>
372+
373+
<li>Change the visualization method if you have chosen more than
374+
one visualization method</li>
375+
376+
<li>Edit a pasted sequence by clicking on the <i class="dropdown-toggle"></i> symbol next to the "<i class="fas fa-paste"></i> Paste FASTA" button</li>
377+
357378
</ul>
358379

359380
<p>When you plot your data using this website, there are a few things
@@ -371,13 +392,15 @@ <h2 id="instructions">Instructions</h2>
371392
supported. We are actively investigating adding more methods.</p>
372393

373394
<p>As you look at an output graph with several overlaid sequences, you
374-
will see that when the sequences completely mirror one another, that
375-
the sequences are essentially identical. When you see the plot lines
376-
begin to diverge, you will instantly be able to see where the
377-
sequences have begun to differ. You can zoom in for a closer view,
378-
then reset the zoom to enable a return the original (unzoomed) view.
379-
When the sequences are parallel on the plot, that tells you that the
380-
sequences are once again identical after a period of divergence.</p>
395+
will see that when the sequences completely mirror one another, that
396+
the sequences are essentially identical. When you see the plot lines
397+
begin to diverge, you will instantly be able to see where the
398+
sequences have begun to differ. You can zoom in for a closer view,
399+
then reset the zoom to enable a return the original (unzoomed) view.
400+
To change the topmost sequence on the visualization, hover over the
401+
legend entry corresponding to the sequence you want to see. When the
402+
sequences are parallel on the plot, that tells you that the sequences
403+
are once again identical after a period of divergence.</p>
381404

382405
<p>Try visualizing your data with each of the visualization
383406
techniques; each method shows your data from a slightly different
@@ -393,19 +416,24 @@ <h2 id="instructions">Instructions</h2>
393416
<h2 id="architecture">Architecture</h2>
394417

395418
<p>DNAvisualization.org is built on an entirelesly serverless
396-
architecture. Due to the inherently parallelizable nature of DNA
397-
sequence transformation (the transformation of one sequence has no
398-
effect on the transformation of another), this design yields a
399-
significant performance increase at a lower cost compared to a
400-
traditional architecture.</p>
419+
architecture. Due to the inherently parallelizable nature of DNA
420+
sequence transformation (the transformation of one sequence has no
421+
effect on the transformation of another), this design yields a
422+
significant performance increase at a lower cost compared to a
423+
traditional architecture.</p>
401424

402425
<p>This website uses <a href="http://flask.pocoo.org">Flask</a> as a
403-
lightweight Python web framework and <a href="https://www.zappa.io">Zappa</a> to automate deployment to Amazon
404-
Web Service's (AWS) <a href="https://aws.amazon.com/lambda">Lambda</a>
405-
serverless computing platform. Additionally, it takes advantace of <a href="https://aws.amazon.com/s3/"> AWS S3</a> for serverless data
406-
storage and querying. All stored data are automatically deleted after 24 hours.</p>
407-
408-
<p>For a full overview of the architecture, take a look at the <a href="https://en.wikipedia.org/wiki/Sequence_diagram">sequence diagram</a> below:</p>
426+
lightweight Python web framework and <a
427+
href="https://www.zappa.io">Zappa</a> to automate deployment to Amazon
428+
Web Service's (AWS) <a href="https://aws.amazon.com/lambda">Lambda</a>
429+
serverless computing platform. Additionally, it takes advantace of <a
430+
href="https://aws.amazon.com/s3/"> AWS S3</a> for serverless data
431+
storage and querying. All stored data are automatically deleted after
432+
24 hours.</p>
433+
434+
<p>For a full overview of the architecture, take a look at the <a
435+
href="https://en.wikipedia.org/wiki/Sequence_diagram">sequence
436+
diagram</a> below:</p>
409437

410438
<div class="mermaid text-center">
411439
{% include "test.mmd" without context %}
@@ -473,18 +501,25 @@ <h2 id="citation" class="pt-2">Citation</h2>
473501
</details>
474502
<h2 id="contact">Contact Us</h2>
475503

476-
<p>Having issues? We're happy to help get them resolved. If you think you've found a bug, the best way to get in touch is to <a href="https://github.com/Benjamin-Lee/DNAvisualization.org/issues/new?assignees=&labels=bug&template=bug_report.md&title="
477-
target="_blank"> make an bug report</a>
478-
on the project's <a href="https://github.com/Benjamin-Lee/DNAvisualization.org">GitHub repository</a>.</p>
504+
<p>Having issues? We're happy to help get them resolved. If you think
505+
you've found a bug, the best way to get in touch is to <a
506+
href="https://github.com/Benjamin-Lee/DNAvisualization.org/issues/new?assignees=&labels=bug&template=bug_report.md&title="
507+
target="_blank"> make an bug report</a> on the project's <a
508+
href="https://github.com/Benjamin-Lee/DNAvisualization.org">GitHub
509+
repository</a>.</p>
479510

480511
<p>Have an idea for another way to turn a DNA sequence into a
481-
two-dimensional visualization? Let us know over on the <a href="https://github.com/Lab41/squiggle/issues/new"> Squiggle repository</a> and we'll be happy to work with you on implementing it.
482-
(DNAvisualization.org uses a stripped-down version of the Squiggle
483-
library to transform sequences.)
484-
</p>
512+
two-dimensional visualization? Let us know over on the <a
513+
href="https://github.com/Lab41/squiggle/issues/new"> Squiggle
514+
repository</a> and we'll be happy to work with you on implementing it.
515+
(DNAvisualization.org uses a stripped-down version of the Squiggle
516+
library to transform sequences.) </p>
517+
518+
<p>To make a feature request for the DNAvisualization.org website,
519+
please click <a
520+
href="https://github.com/Benjamin-Lee/DNAvisualization.org/issues/new?assignees=&labels=enhancement&template=feature_request.md&title="
521+
target="_blank">here</a>. </p>
485522

486-
<p>To make a feature request for the DNAvisualization.org website, please click <a href="https://github.com/Benjamin-Lee/DNAvisualization.org/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=" target="_blank">here</a>.
487-
</p>
488523
</div>
489524
</div>
490525
</div><!-- /container -->

0 commit comments

Comments
 (0)