Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
✓DOI references
Found 2 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.6%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: vlm-canvas-bugs-external-repos
- License: mit
- Language: JavaScript
- Default Branch: user9237590463948-new-branch
- Size: 152 MB
Statistics
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
Introduction
HiGlass is a web-based viewer for datasets too large to view at once. It features synchronized navigation of multiple views as well as continuous zooming and panning for navigation across genomic loci and resolutions. It supports visual comparison of genomic (e.g., Hi-C, ChIP-seq, or bed annotations) and other data (e.g., geographic maps, gigapixel images, or abstract 1D and 2D sequential data) from different experimental conditions and can be used to efficiently identify salient outcomes of experimental perturbations, generate new hypotheses, and share the results with the community.
A live instance can be found at https://higlass.io. A Docker container is available for running an instance locally, although we recommend using the higlass-manage package to start, stop and configure local instances.
For documentation about how to use and install HiGlass, please visit https://docs.higlass.io.
Citation
Kerpedjiev, P., Abdennur, N., Lekschas, F., McCallum, C., Dinkla, K., Strobelt, H., ... & Gehlenborg, N. HiGlass: Web-based Visual Exploration and Analysis of Genome Interaction Maps. Genome Biology (2018): 19:125. https://doi.org/10.1186/s13059-018-1486-1
Example
Development
To run higlass from its source code simply run the following:
npm clean-install // use --legacy-peer-deps if you get peer dependency errors
npm run start
This starts a server in development mode at http://localhost:5173/.
Warning The following examples need to be migrated to the latest build. Once started, a list of the examples can be found at http://localhost:8080/examples.html. Template viewconfs located at
/docs/examples/viewconfscan viewed directly at urls such as http://localhost:8080/apis/svg.html?/viewconfs/overlay-tracks.json.
Tests
The tests for the React components and API functions are located in the test directory.
Tests are run with web-test-runner, which you can learn more about the CLI in the documentation.
Useful commands:
- Run all tests:
npm test - Run all tests in interactive "watch" mode:
npm test -- --watch - Run a specific test or "glob" of tests:
npm test -- test/APITests.js [--watch] - Manually run individual tests in an open browser window:
npm test -- --manual
Troubleshooting:
- If the installation fails due to
sharp>node-gyptry installing the node packages usingpython2:
npm ci --python=/usr/bin/python2 && rm -rf node_modules/node-sass && npm ci
API
HiGlass provides an API for controlling the component from with JavaScript. Below is a minimal working example to get started and the complete documentation is availabe at docs.higlass.io.
```html <!DOCTYPE html>