Skip to content

Commit

Permalink
First Github release candidate.
Browse files Browse the repository at this point in the history
  • Loading branch information
stephenshank committed Jun 14, 2018
1 parent 3c9f3cd commit 422a5ed
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 4 deletions.
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,39 @@
# alignment.js
Javascript alignment viewer.

A suite of reusable [React](http://reactjs.org/) components for creating a variety of visualizations involving [multiple sequence alignments](https://en.wikipedia.org/wiki/Multiple_sequence_alignment). [View the live demo here](http://alignment.hyphy.org/).

`alignment.js` can be used to create standard MSA viewers, utilizing functional programming to permit custom behavior such as highlighting individual sites:

![alt text](images/standard.png)

as well as scaffold viewers for next-generation sequencing data where a reference sequence stays fixed to the top:

![alt text](images/scaffold.gif)

and joint phylogeny/alignment viewers using packages like [phylotree.js](https://github.com/veg/phylotree.js):

![alt text](images/phyalign.png)

## Installation

`alignment.js` is [available on NPM](https://www.npmjs.com/package/alignment.js) and can thus be installed with `npm`

```
npm install alignment.js
```

or `yarn`

```
yarn add alignment.js
```

## Development

Install a local copy:

```
git clone https://github.com/stephenshank/alignment.js
git clone https://github.com/veg/alignment.js
cd alignment.js
yarn
```
Expand Down
Binary file added images/phyalign.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/scaffold.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/standard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "alignment.js",
"version": "1.0.8",
"version": "1.0.9",
"main": "lib/alignment.js",
"license": "MIT",
"dependencies": {
Expand Down
1 change: 0 additions & 1 deletion src/scaffold_viewer.js
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,6 @@ class ScaffoldViewer extends Component {
},
reference_sequence_data = this.sequence_data.slice(0,1),
remaining_sequence_data = this.sequence_data.slice(1);
debugger;
return (<div
style={container_style}
id='alignmentjs-main-div'
Expand Down

0 comments on commit 422a5ed

Please sign in to comment.