Skip to content
Tomasz Neugebauer edited this page Apr 4, 2018 · 42 revisions

FluentDNA User Documentation

Introduction

FluentDNA is a multi-platform command-line tool for generating visualizations of DNA data.


Generating visualizations

After you have the software installed (insert link to installation instructions), the command line is used to generate visualizations that are accessible through a localhost web browser or a local image viewer. First, launch the FluentDNA server using fluentdna.py --runserver This will make all your results available at http://127.0.0.1:8000


Simple FASTA file (DNA)

Generating a basic visualization of a FASTA file downloaded from NCBI or another source is accomplished with the following commands:

Command: fluentdna.py --fasta="example_data/hg38_chr19_sample.fa" --outname="Test Simple"

This generates an image pyramid with the standard legend (insert image of legend) and nucleotide number display.

Input Data Example:

Result: Hg38 chr19 sample Example FluentDNA output of Human Chr19 2MBp

It is also possible to generate an image file only that can be accessed with an image viewer using --no_webpage.

Command: fluentdna.py --fasta="example_data/hg38_chr19_sample.fa" --outname="Test Simple" --no_webpage


Multi-part FASTA file (DNA)

Multi-part FASTA format includes multiple sequences in the same file. A sequence record in a FASTA format consists of a single-line description (sequence name), followed by line(s) of sequence data. The first character of the description line is a greater-than (">") symbol. Multi-part format Example:

>seq0
AATGCCA
>seq1
GCCCTAT

The following command generates a multi-part FASTA file visualization:

Input Data Example:

Command: fluentdna.py --fasta="example_data/Human selenoproteins.fa"
Result: Human Selenoproteins

This generates a multi-scale image of the multi-part FASTA file. Note that if you don't specify --outname= it will default to the name of the FASTA file.

Using this simple command, FluentDNA can visualize an entire draft genome at once.
Result: Ash Tree Genome (Fraxinus excelsior) Fraxinus excelsior genome

Additional options - see also:

  • --outname
  • --sort_contigs
  • --no_titles
  • --natural_colors
  • --base_width

Annotated Genomes

By specifying --ref_annotation= you can include a gene annotation to be rendered alongside your sequence. This is currently setup to show gene introns and exons. But the features rendered and colors used can be changed in DDV/Annotations.py

Command: fluentdna.py --fasta="example_data/gnetum_sample.fa" --ref_annotation="example_data/Gnetum_sample_genes.gff"

Input Data Example:

Result: Gnetum montanum Annotation Gnetum montanum Annotation


Multiple Sequence Alignment Families

To visualize a multiple sequence alignment you need to use the --layout=alignment option to tell FluentDNA to treat each entry in a multipart fasta file as being one row of an alignment. To show many MSAs at once, just point --fasta= to a folder instead of a file.

Command: fluentdna.py --layout=alignment --fasta="example_data\alignments" --outname="Example 7 Gene Families from Fraxinus"

This generates a multi-scale image of the multiple alignment. The multiple alignment results are sorted by gene name. For a smoother layout use --sort_contigs which will sort them by row count (copy number).

Result: Example 7 Gene Families from Fraxinus

This layout allows users to check thousands of MSAs. Here we used FluentDNA to quality check the merging software for 2,961 putative gene families: Fraxinus Homologous Gene Groups


Alignment of two Genomes

This generates an alignment visualization of two genomes (A and B):

Command: (insert command to generate)

This generates a multi-scale image of the alignment. There are 4 columns in this visualization:

  • Column 1. Genome A (gapped entire DNA of genome A)
  • Column 2. Genome A (unique DNA of A)
  • Column 3. Genome B (unique DNA of B)
  • Column 4. Genome B (gapped entire DNA of genome B)

For example, the following data file: (insert data file link)

Result: https://dnaskittle.com/ddvresults/dnadata/Parallel_hg38_and_panTro5_chr19/


Clone this wiki locally