Running `assembly-stats` on github pages.

Demo: https://ammaraziz.github.io/assembly-stats/

Detailed instructions to run assembly-stats on github pages

Fork this repo by pressing the Fork button (top right)
Configure github pages to run on the repo
- Go to Settings then on the left hand bar go to Pages
- Under Source click the dropdown menu (None), select Master, click Save
- The page should updates and a green tick should appear next to Your site is published at ......
- Remember the above link!
Option 1 - Push your .json file to 'json/'
- json must be named in this fashion: output.assembly-stats.{customName}.json
Option 2 - Manually edit the .json file
- Click on <> Code (this should return you to the repo home screen where the files are listed)
- Click on the folder called json
- Click on the file named output.assembly-stats.json
- Click on the pencil icon to edit the json file (top right)
- Paste your own json file into the edit box
- Under Commit changes enter a commit title (anything, doesnt matter)
- Click commit
Go to the link saved above, mine is at https://ammaraziz.github.io/assembly-stats/ your link will look like https://{YourUserName}.github.io/assembly-stats/
Be patient, github is generating the webpage. Refresh a few times. If you are super impatient, click on Actions button to see the progress.

Short instructions

Fork this repo
Configure github pages to work on the master bracnh
Push your .json file to 'json/'
json must be named in this fashion: output.assembly-stats.{customName}.json

Please cite the original repo! All credit goes to rjchallis.

What has been changed

All code, design and programming was done by user @rjchallis. We have modified a few lines of code to allow the html to work nicely with Github Pages.

assembly-stats - Original info below

Assembly metric visualisations to facilitate rapid assessment and comparison of assembly quality.

Live demo

Latest and most complete documentation is available at assembly-stats.readme.io

Description

A de novo genome assembly can be summarised by a number of metrics, including:

Overall assembly length
Number of scaffolds/contigs
Length of longest scaffold/contig
Scaffold/contig N50 and N90
Assembly base composition, in particular percentage GC and percentage Ns
CEGMA completeness
Scaffold/contig length/count distribution

assembly-stats supports two widely used presentations of these values, tabular and cumulative length plots, and introduces an additional circular plot that summarises most commonly used assembly metrics in a single visualisation. Each of these presentations is generated using javascript from a common (JSON) data structure, allowing toggling between alternative views, and each can be applied to a single or multiple assemblies to allow direct comparison of alternate assemblies.

Tabular presentation allows direct comparison of exact values between assemblies, the limitations of this approach lie in the necessary omission of distributions and the challenge of interpreting ratios of values that may vary by several orders of magnitude.

Cumulative scaffold length plots are highly effective for comparison of two or more assemblies, plotting both on a single set of axes reveals differences in assembled size and the N50 count very clearly. However, other metrics must still be tabulated or annotated on the plot for example N50 length and the longest scaffold length can be particularly difficult to determine from the plot alone. The scale for the axes is usually chosen to accommodate the data for a single assembly or set of assemblies, meaning that it is usually necessary to replot the data or consider the relative axis scales carefully to compare assemblies that have been plotted separately. The cumulative distribution plots in assembly-stats address the problem of scaling by allowing any combination of assemblies to be plotted together and allowing rescaling of the axes to fit any one of the individual assemblies.

The circular plots have been introduced to overcome some of the shortcomings of tabular and cumulative distribution plots in a visualisation that allows rapid assessment of most common assembly metrics. The graphic is essentially scale independent so assemblies of any size with different strengths and weaknesses produce distinct patterns that can be recognised at a glance. While side by side presentation of a pair of assemblies on consistently scaled axes allows direct comparison, the standard presentation is designed to facilitate assessment of overall assembly quality by consideration of the keys features from the plot.

plot descritption

click on any colour tile in the legend to toggle visibility of that feature on/off
The inner radius of the circular plot represents the length of the longest scaffold in the assembly
The angle subtended by the first (red) segment within this plot indicates the percentage of the assembly that is in the longest scaffold
The radial axis originates at the circumference and indicates scaffold length
Subsequent (grey) segments are plotted from the circumference and the length of segment at a given percentage indicates the cumulative percentage of the assembly that is contained within scaffolds of at least that length
The N50 and N90 scaffold lengths are indicated respectively by dark and light orange arcs that connect to the radial axis for ease of comparison
The cumulative number of scaffolds within a given percentge of the genome is plotted in purple originating at the centre of the plot
White scale lines are drawn at successive orders of magnitude from 10 scaffolds onwards
The fill colour of the circumferential axis indicates the percentage base composition of the assembly: AT = light blue; GC = dark blue; N = grey
Contig length (if available) is indicated by darker grey segments overlaying the scaffold length plot
Contig count (if available) may be toggled on to be shown in place of the scaffold count plot
Complete, fragmented and duplicated BUSCO genes (if available) are shown in mid, light and dark green, respectively in the smaller plot in the upper right corner
Partial and complete CEGMA values (if available) are shown in light and dark green, respectively in the smaller plot in the upper right corner

basic usage

input format

Data to be plotted must be supplied as a JSON format object. As of version 1.1 data may be pre-binned to improve performance with assemblies containing potentially millions of contigs. The simplest way to generate this is using the asm2stats.pl or asm2stats.minmaxgc.pl perl scripts in the pl folder:

perl asm2stats.pl genome_assembly.fa > output.json
perl asm2stats.minmaxgc.pl genome_assembly.fa > output.minmaxgc.json

This input format should be preferred as it improves performance and corrects for a bug in the javascript binning code by adjusting bin size to accommodate assembly spans that are not divisible by 1000, however the previous input format (with a full list of scaffold lengths is still supported).

usage

The simplest plot requires a target div, an assembly span, a count of ACGT bases, the GC percentage and an array of scaffold lengths, however it is best to use the asm2stats.pl/asm2stats.minmaxgc.pl perl scripts described above to generate a richer, pre-processed input format. See the Danaus_plexippus_v3.assembly-stats.json file for a complete example using pre-binned data, basic usage is detailed below:

<div id="assembly_stats">
<script>
  d3.json("Danaus_plexippus_v3.assembly-stats.json", function(error, json) {
    if (error) return console.warn(error);
    asm = new Assembly (json);
    asm.drawPlot('assembly_stats');
  })
</script>

The json object contains the following keys:

assembly - the total assembly span
ATGC - the assembly span without Ns (redundant if N is specified)
GC - the GC percentage of the assembly
N - the total number of Ns (redundant if ATGC is specified)
scaffold_count - the total number of scaffolds in the assembly
scaffolds - an array of scaffold lengths (only the longest scaffold is needed if binned_scaffold_lengths and binned_scaffold_counts are specified)
binned_scaffold_lengths - an array of 1000 scaffold lengths representing the N0.1 to N100 scaffold lengths for the assembly
binned_scaffold_counts - an array of 1000 scaffold counts representing the N0.1 to N100 scaffold numbers for the assembly
contig_count - (optional) the total number of contigs in the assembly
contigs - (optional) an array of contig lengths (only the longest contig is needed if binned_contig_lengths and binned_contig_counts are specified)
binned_contig_lengths - (optional) an array of 1000 contig lengths representing the N0.1 to N100 contig lengths for the assembly
binned_contig_counts - (optional) an array of 1000 contig counts representing the N0.1 to N100 contig numbers for the assembly
binned_Ns - (optional) an array of 1000 values representing the N content of each bin based on size-sorted scaffold sequences
binned_GCs - (optional) an array of 1000 values representing the GC content of each bin based on size-sorted scaffold sequences

Additional data will be plotted, if added to the stats object including:

CEGMA scores

cegma_complete:    83.87,
cegma_partial:    95.16

BUSCO complete, duplicated, fragmented, missing and number of genes (will be plotted in place of CEGMA if both are present)

busco: { C:87.1,
         D:3.6,
         F:10.1,
         M:2.8,
         n:2675 }

While the plots were conceived as scale independent visualisations, there are occasions when it is useful to compare assemblies on the same radial (longest scaffold) or circumferential (assembly span) scales. These scales may be modified on the plot by clicking the grey boxes under the scale heading. Plots can also be drawn with an specific scale by supplying additional arguments to drawPlot().

For example to scale the radius to 10 Mb and the circumference to 400 Mb (values smaller than the default will be ignored):

  asm.drawPlot('assembly_stats',10000000,400000000);

It is also possible to programmatically toggle the visibility of plot features by passing an array of classnames to toggleVisible():

  asm.toggleVisible(['asm-longest_pie','asm-count']);

tinameiring/assembly-stats

Running assembly-stats on github pages.