https://github.com/higlass/higlass-vcf

https://github.com/higlass/higlass-vcf

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/higlass/higlass-vcf
• Owner: higlass
• License: mit
• Created: 2020-04-24T03:02:06.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2025-08-06T23:05:37.000Z (10 months ago)
• Last Synced: 2025-08-09T07:52:06.295Z (10 months ago)
• Language: JavaScript
• Size: 1.67 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# HiGlass VCF Track

> Track for viewing VCF files.

[![HiGlass](https://img.shields.io/badge/higlass-👍-red.svg?colorB=0f5d92)](http://higlass.io)

[![Build Status](https://img.shields.io/travis/higlass/higlass-pileup-track/master.svg?colorB=0f5d92)](https://travis-ci.org/higlass/higlass-pileup-track)



**Note**: This is the source code for the pileup only! You might want to check out the following repositories as well:

- HiGlass viewer: https://github.com/higlass/higlass

- HiGlass server: https://github.com/higlass/higlass-server

- HiGlass docker: https://github.com/higlass/higlass-docker

## Installation

```

npm install higlass-vcf

```

## Usage

The live scripts can be found at:

- https://unpkg.com/higlass-vcf@v0.1.4/dist/higlass-vcf.min.js

### Client

1. Make sure you load this track prior to `hglib.js`. For example:

```

  ...

```

2. Now, configure the track in your view config and be happy!

```

{

  "editable": true,

  "trackSourceServers": [

    "http://higlass.io/api/v1"

  ],

  "exportViewUrl": "/api/v1/viewconfs",

  "views": [

    {

      "initialXDomain": [

        0,

        100000

      ],

      "tracks": {

        "top": [

          {

            "type": "vcf",

            "height": 180,

            "uid": "FylkvVBTSumoJ959HT4-5A",

            "data": {

              "type": "vcf",

              "url": "https://pkerp.s3.amazonaws.com/public/HG002_SVs_Tier1_v0.6.vcf.gz",

              "chromSizesUrl": "https://resgen.io/api/v1/chrom-sizes/?id=cNE4StljSAK9lK3amECl-A"

            },

          }

        ]

      }

    }

  ]

}

```

## Support

For questions, please either open an issue or ask on the HiGlass Slack channel at http://bit.ly/higlass-slack

## Development

### Installation

```bash

$ git clone https://github.com/higlass/higlass-vcf-track && higlass-vcf-track

$ npm install

```

### Commands

**Developmental server**: `npm start`

**Production build**: `npm run build`