Skip to content

Commit

Permalink
Merge branch 'develop' with release 4.0.6
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel Perrett committed Aug 1, 2022
2 parents ea50857 + a1d94d2 commit 1dace96
Show file tree
Hide file tree
Showing 4 changed files with 425 additions and 538 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Genoverse [![Build Status](https://github.com/wtsi-web/Genoverse/actions/workflows/test.yml/badge.svg)](https://github.com/wtsi-web/Genoverse/actions)
# Genoverse [![Build Status](https://github.com/WTSI-decipher-grp/Genoverse/actions/workflows/test.yml/badge.svg)](https://github.com/WTSI-decipher-grp/Genoverse/actions)

Genoverse is a portable, customizable, back-end independent JavaScript and HTML5 based genome browser which allows the user to explore data in a dynamic and interactive manner.

Data is visualized in the browser, meaning Genoverse can be installed on any website and show data from a wide range of online or local sources.

Genoverse works with a variety of formats, such as JSON, BED, BAM, VCF, GFF, delimited text files, or XML, and can be customized to parse and display any data source as required.

Genoverse works using a system of [tracks](https://github.com/wtsi-web/Genoverse/wiki/Tracks) - essentially horizontal sections of the genome browser which display [features](https://github.com/wtsi-web/Genoverse/wiki/Features) - genes, variants, etc. with defined genomic start and end points. Each track has its own data set stored in a [model](https://github.com/wtsi-web/Genoverse/wiki/Genoverse.Track.Model-functions), a method for displaying that data, stored in a [view](https://github.com/wtsi-web/Genoverse/wiki/Genoverse.Track.View-functions), and a [controller](https://github.com/wtsi-web/Genoverse/wiki/Genoverse.Track.Controller-functions) to manage the creation of DOM elements, and user interactions with them.
Genoverse works using a system of [tracks](https://github.com/WTSI-decipher-grp/Genoverse/wiki/Tracks) - essentially horizontal sections of the genome browser which display [features](https://github.com/WTSI-decipher-grp/Genoverse/wiki/Features) - genes, variants, etc. with defined genomic start and end points. Each track has its own data set stored in a [model](https://github.com/WTSI-decipher-grp/Genoverse/wiki/Genoverse.Track.Model-functions), a method for displaying that data, stored in a [view](https://github.com/WTSI-decipher-grp/Genoverse/wiki/Genoverse.Track.View-functions), and a [controller](https://github.com/WTSI-decipher-grp/Genoverse/wiki/Genoverse.Track.Controller-functions) to manage the creation of DOM elements, and user interactions with them.

Tracks can have multiple models and views, which allows for switching between displays at different zoom levels. An example of this would be a track where you show genes when looking at a large region of a chromosome, and then switch to showing transcripts as the user zooms in.

In addition to this, Genoverse has a set of [plugins](https://github.com/wtsi-web/Genoverse/wiki/Plugins), which allow additional functionality beyond the core genome browser. These include a control panel for adding and removing tracks, and interacting with the browser more easily, a way to add controls to each individual track, and a way to enable drag and drop of local data files onto the genome browser.
In addition to this, Genoverse has a set of [plugins](https://github.com/WTSI-decipher-grp/Genoverse/wiki/Plugins), which allow additional functionality beyond the core genome browser. These include a control panel for adding and removing tracks, and interacting with the browser more easily, a way to add controls to each individual track, and a way to enable drag and drop of local data files onto the genome browser.

## Installation

Expand Down Expand Up @@ -42,7 +42,7 @@ const genoverse = Genoverse.jQuery(container).data('genoverse');

By default, the Genoverse distribution in created with [Babel](https://babeljs.io/) and certain [polyfills](https://github.com/zloirock/core-js/blob/master/README.md), in order to support old web browsers like Internet Explorer 11.

If you want to create your own distribution bundle, see `devDependencies` in [package.json](https://github.com/wtsi-web/Genoverse/blob/master/package.json) for Webpack/Babel packages you need to install in order to be able to do so.
If you want to create your own distribution bundle, see `devDependencies` in [package.json](https://github.com/WTSI-decipher-grp/Genoverse/blob/master/package.json) for Webpack/Babel packages you need to install in order to be able to do so.

Once these dependencies are installed, distributions can be built with [webpack-cli](https://webpack.js.org/api/cli/).

Expand Down Expand Up @@ -179,4 +179,4 @@ new Genoverse({
});
```

See [index.html](https://github.com/wtsi-web/Genoverse/blob/master/index.html) for example configuration, or the [documentation](https://github.com/wtsi-web/Genoverse/wiki/Genoverse-configuration) for more details about configuration properties.
See [index.html](https://github.com/WTSI-decipher-grp/Genoverse/blob/master/index.html) for example configuration, or the [documentation](https://github.com/WTSI-decipher-grp/Genoverse/wiki/Genoverse-configuration) for more details about configuration properties.
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "genoverse",
"version": "4.0.5",
"version": "4.0.6",
"description": "Genoverse is a portable, customizable, back-end independent JavaScript and HTML5 based genome browser which allows the user to explore data in a dynamic and interactive manner.",
"main": "src/js/Genoverse.js",
"directories": {
Expand All @@ -16,14 +16,14 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/wtsi-web/Genoverse.git"
"url": "git+https://github.com/WTSI-decipher-grp/Genoverse.git"
},
"author": "Simon Brent",
"license": "BSD-3-Clause",
"bugs": {
"url": "https://github.com/wtsi-web/Genoverse/issues"
"url": "https://github.com/WTSI-decipher-grp/Genoverse/issues"
},
"homepage": "https://wtsi-web.github.io/Genoverse/",
"homepage": "https://wtsi-decipher-grp.github.io/Genoverse/",
"devDependencies": {
"@babel/core": "^7.17.2",
"@babel/eslint-parser": "^7.17.0",
Expand Down
2 changes: 1 addition & 1 deletion src/js/Track/Model/Sequence/Fasta.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import Model from '../Sequence';

export default Model.extend({
url: 'https://wtsi-web.github.io/Genoverse/data/Homo_sapiens.GRCh37.72.dna.chromosome.1.fa', // Example url
url: 'https://wtsi-decipher-grp.github.io/Genoverse/data/Homo_sapiens.GRCh37.72.dna.chromosome.1.fa', // Example url

// Following settings could be left undefined and will be detected automatically via .getStartByte()
startByte : undefined, // Byte in the file where the sequence actually starts
Expand Down
Loading

0 comments on commit 1dace96

Please sign in to comment.