Skip to content

Commit

Permalink
Merge branch 'master' into genark_genome_improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
jrobinso authored Oct 25, 2024
2 parents 86209f5 + e3fdbb4 commit 4328437
Show file tree
Hide file tree
Showing 67 changed files with 1,524 additions and 658 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,19 @@ Below are examples and a quickstart guide. See the [developer documentation](ht

# Examples

***[Alignments](https://igv.org/web/release/3.0.3/examples/cram-vcf.html)***
***[Alignments](https://igv.org/web/release/3.0.8/examples/cram-vcf.html)***

***[Interactions](https://igv.org/web/release/3.0.3/examples/interact.html)***
***[Interactions](https://igv.org/web/release/3.0.8/examples/interact.html)***

***[Copy number](https://igv.org/web/release/3.0.3/examples/copyNumber.html)***
***[Copy number](https://igv.org/web/release/3.0.8/examples/copyNumber.html)***

***[Multiple regions](https://igv.org/web/release/3.0.3/examples/multi-locus.html)***
***[Multiple regions](https://igv.org/web/release/3.0.8/examples/multi-locus.html)***

***[Mutation Annotation Format (MAF)](https://igv.org/web/release/3.0.3/examples/maf-tcga.html)***
***[Mutation Annotation Format (MAF)](https://igv.org/web/release/3.0.8/examples/maf-tcga.html)***

***[Variant color options](https://igv.org/web/release/3.0.3/examples/variant-colors.html)***
***[Variant color options](https://igv.org/web/release/3.0.8/examples/variant-colors.html)***

***[More](https://igv.org/web/release/3.0.3/examples/)***
***[More](https://igv.org/web/release/3.0.8/examples/)***


# Quickstart
Expand All @@ -39,18 +39,18 @@ Below are examples and a quickstart guide. See the [developer documentation](ht
igv.js consists of a single javascript file with no external dependencies.

Pre-built files for script include, AMD, or CJS module systems (igv.min.js) and an ES6 module (igv.esm.min.js)
can be downloaded from [https://cdn.jsdelivr.net/npm/igv@3.0.3/dist/](https://cdn.jsdelivr.net/npm/igv@3.0.3/dist/).
can be downloaded from [https://cdn.jsdelivr.net/npm/igv@3.0.8/dist/](https://cdn.jsdelivr.net/npm/igv@3.0.8/dist/).

To import igv as an ES6 module

```javascript
import igv from "https://cdn.jsdelivr.net/npm/igv@3.0.3/dist/igv.esm.min.js"
import igv from "https://cdn.jsdelivr.net/npm/igv@3.0.8/dist/igv.esm.min.js"
```

Or as a script include (defines the "igv" global)

```html
<script src="https://cdn.jsdelivr.net/npm/igv@3.0.3/dist/igv.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/igv@3.0.8/dist/igv.min.js"></script>
```

Alternatively you can install with npm
Expand Down Expand Up @@ -91,7 +91,9 @@ a browser on a single alignment track opened at a specific locus:
})
```

For more details see the [Wiki](https://github.com/igvteam/igv.js/wiki) for full documentation of the API.
## Documentation

Full documentation of the igv.js API is available at [https://igv.org/doc/igvjs/](https://igv.org/doc/igvjs/).

## Development

Expand Down
1 change: 0 additions & 1 deletion css/_igv-ui-generic-dialog-container.scss
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,6 @@
color: $igv-dark-grey-color;

width: 95%;
height: 24px;
line-height: 24px;

text-align: left;
Expand Down
1 change: 0 additions & 1 deletion css/igv.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

43 changes: 17 additions & 26 deletions dev/alignment/bam.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,35 +21,26 @@ <h2>

const config =
{
"version": "3.0.2",
"showSampleNames": false,
"reference": {
"id": "mm39",
"name": "Mouse (GRCm39/mm39)",
"fastaURL": "https://s3.amazonaws.com/igv.org.genomes/mm39/mm39.fa",
"indexURL": "https://s3.amazonaws.com/igv.org.genomes/mm39/mm39.fa.fai",
"cytobandURL": "https://hgdownload.soe.ucsc.edu/goldenPath/mm39/database/cytoBandIdeo.txt.gz",
"aliasURL": "https://hgdownload.soe.ucsc.edu/goldenPath/mm39/bigZips/mm39.chromAlias.txt",
"twoBitURL": "https://hgdownload.soe.ucsc.edu/goldenPath/mm39/bigZips/mm39.2bit",
"chromSizesURL": "https://hgdownload.soe.ucsc.edu/goldenPath/mm39/bigZips/mm39.chrom.sizes",
"chromosomeOrder": "chr1,chr2,chr3,chr4,chr5,chr6,chr7,chr8,chr9,chr10,chr11,chr12,chr13,chr14,chr15,chr16,chr17,chr18,chr19,chrX,chrY"
},
"locus": "all",
"queryParametersSupported": true,
"genome": "hg19",
"locus": "chr1:155155389",
"roi": [],
"tracks": [
{
"type": "sequence",
"order": -9007199254740991
},
,
{
"name": "Refseq Genes",
"format": "refgene",
"url": "https://hgdownload.soe.ucsc.edu/goldenPath/mm39/database/ncbiRefSeq.txt.gz",
"indexed": false,
"order": 1000000,
"type": "annotation",
"height": 70
"type": "alignment",
"url": "gs://genomics-public-data/platinum-genomes/bam/NA12878_S1.bam",
"indexURL": "gs://genomics-public-data/platinum-genomes/bam/NA12878_S1.bam.bai",
"name": "NA12878",
"format": "bam",
"sort": {
"chr": "chr1",
"position": 155155389,
"option": "BASE",
"direction": "ASC"
},
groupBy: "strand",
height: 800,
filter: {mq: 30}
}
]
}
Expand Down
4 changes: 2 additions & 2 deletions dev/annotation/gff.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ <h1>gff and gtf files</h1>
reference: {
"id": "hg38",
"name": "Human (GRCh38/hg38)",
"fastaURL": "https://igv-genepattern-org.s3.amazonaws.com/genomes/seq/hg38/hg38.fa",
"indexURL": "https://igv-genepattern-org.s3.amazonaws.com/genomes/seq/hg38/hg38.fa.fai",
"fastaURL": "https://igv.org/genomes/data/hg38/hg38.fa",
"indexURL": "https://igv.org/genomes/data/hg38/hg38.fa.fai",
//"twoBitURL": "https://hgdownload.soe.ucsc.edu/goldenPath/hg38/bigZips/hg38.2bit",
},
locus: "chr8:127,736,541-127,736,692 chr1:155,186,114-155,186,153",
Expand Down
53 changes: 7 additions & 46 deletions dev/encode/bigwig.html
Original file line number Diff line number Diff line change
@@ -1,46 +1,24 @@
<head>

<link rel="stylesheet" href="https://unpkg.com/@reservoirgenomics/resglass@1.20.5/dist/hglib.css">
<script crossorigin src="https://unpkg.com/higlass-plugins@0.2.1/dist/higlass-plugins.min.js">

</script>
<script crossorigin src="https://unpkg.com/@reservoirgenomics/resglass@1.20.5/dist/hglib.js">

</script>

<meta charset="UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=edge"/>
<title>Juicebox</title>
<title>IGV</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>

<!-- IGV JS -->
<script src="../../dist/igv.min.js"></script>



</head>
<body>

<div id="igv-container" style="width: auto; margin-left: 10px; border: 1px solid black;">
</div>

<script>
<script type="module">

import igv from "../../js/index.js"

const igvConfig ={
"reference": {
"id": "hg19",
"name": "Human (CRCh37/hg19)",
"fastaURL": "https://s3.amazonaws.com/igv.broadinstitute.org/genomes/seq/hg19/hg19.fasta",
"indexURL": "https://s3.amazonaws.com/igv.broadinstitute.org/genomes/seq/hg19/hg19.fasta.fai",
"cytobandURL": "https://s3.amazonaws.com/igv.broadinstitute.org/genomes/seq/hg19/cytoBand.txt"
},
"locus": [
"chr8:128,746,315-128,755,680"
],
"genome": "hg19",
"locus": "chr8:128,746,315-128,755,680",
"tracks": [
{
"type": "sequence",
"order": -1.7976931348623157e+308
},
{
"url": "https://www.encodeproject.org/files/ENCFF000ATR/@@download/ENCFF000ATR.bigWig",
"color": "#018448",
Expand Down Expand Up @@ -76,23 +54,6 @@
"height": 50,
"autoscale": true,
"order": 5
},
{
"name": "Refseq Genes",
"format": "refgene",
"url": "https://s3.amazonaws.com/igv.org.genomes/hg19/refGene.sorted.txt.gz",
"indexURL": "https://s3.amazonaws.com/igv.org.genomes/hg19/refGene.sorted.txt.gz.tbi",
"visibilityWindow": -1,
"removable": false,
"order": 1000000,
"filename": "refGene.sorted.txt.gz",
"sourceType": "file",
"type": "annotation",
"maxRows": 500,
"filterTypes": [
"chromosome",
"gene"
]
}
]
}
Expand Down
74 changes: 74 additions & 0 deletions dev/issues/git-1886.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Git Issue - 1886</title>
</head>
<body>

<header>
<h1>Git Issue - 1886</h1>
</header>

<main>
<div id="igvDiv" style="padding-top: 50px;padding-bottom: 20px; height: auto"></div>
</main>

<script type="module">

import igv from "../../js/index.js"

const config =
{
"version": "3.0.5",
"showSampleNames": false,
"reference": {
"id": "hg19",
"name": "Human (GRCh37/hg19)",
"fastaURL": "https://igv-genepattern-org.s3.amazonaws.com/genomes/seq/hg19/hg19.fasta",
"indexURL": "https://igv-genepattern-org.s3.amazonaws.com/genomes/seq/hg19/hg19.fasta.fai",
"cytobandURL": "https://hgdownload.soe.ucsc.edu/goldenPath/hg19/database/cytoBand.txt.gz",
"aliasURL": "https://hgdownload.soe.ucsc.edu/goldenPath/hg19/bigZips/hg19.chromAlias.txt",
"twoBitURL": "https://hgdownload.soe.ucsc.edu/goldenPath/hg19/bigZips/hg19.2bit",
"chromSizesURL": "https://hgdownload.soe.ucsc.edu/goldenPath/hg19/bigZips/hg19.chrom.sizes",
"chromosomeOrder": "chr1,chr2,chr3,chr4,chr5,chr6,chr7,chr8,chr9,chr10,chr11,chr12,chr13,chr14,chr15,chr16,chr17,chr18,chr19,chr20,chr21,chr22,chrX,chrY"
},
"locus": "chr3:86,924,605-86,924,924",
"roi": [],
"tracks": [
{
"type": "sequence",
"order": -9007199254740991
},
{
"sourceType": "gcs",
"type": "alignment",
"url": "gs://genomics-public-data/platinum-genomes/bam/NA12889_S1.bam",
"indexURL": "gs://genomics-public-data/platinum-genomes/bam/NA12889_S1.bam.bai",
"name": "NA12889",
"order": 0,
"colorBy": "unexpectedPair"
},
{
"name": "Refseq Genes",
"format": "refgene",
"id": "hg19_genes",
"url": "https://hgdownload.soe.ucsc.edu/goldenPath/hg19/database/ncbiRefSeq.txt.gz",
"indexed": false,
"order": 1000000,
"infoURL": "https://www.ncbi.nlm.nih.gov/gene/?term=$$",
"type": "annotation",
"height": 70
}
]
}

igv.createBrowser(document.getElementById('igvDiv'), config)
.then(browser => {
console.log(`browser ${ browser.guid } is good to go`)
})

</script>
</body>
</html>
35 changes: 0 additions & 35 deletions dev/issues/issue_1643.html

This file was deleted.

12 changes: 1 addition & 11 deletions dev/sampleInfo/sampleInfoFileSession.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,7 @@
{
"version": "2.16.0",
"showSampleNames": false,
"reference": {
"id": "hg38",
"name": "Human (GRCh38/hg38)",
"fastaURL": "https://igv-genepattern-org.s3.amazonaws.com/genomes/seq/hg38/hg38.fa",
"indexURL": "https://igv-genepattern-org.s3.amazonaws.com/genomes/seq/hg38/hg38.fa.fai",
"cytobandURL": "https://igv-genepattern-org.s3.amazonaws.com/genomes/hg38/cytoBandIdeo.txt.gz",
"aliasURL": "https://igv-genepattern-org.s3.amazonaws.com/genomes/hg38/hg38_alias.tab",
"chromSizesURL": "https://hgdownload.soe.ucsc.edu/goldenPath/hg38/bigZips/hg38.chrom.sizes",
"twoBitURL": "https://hgdownload.soe.ucsc.edu/goldenPath/hg38/bigZips/hg38.2bit",
"chromosomeOrder": "chr1,chr2,chr3,chr4,chr5,chr6,chr7,chr8,chr9,chr10,chr11,chr12,chr13,chr14,chr15,chr16,chr17,chr18,chr19,chr20,chr21,chr22,chrX,chrY"
},
"genome": "hg38",
"locus": "chr22:36,655,100-36,656,060",
"roi": [],
"tracks": [
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
27 changes: 27 additions & 0 deletions dev/shoebox/old/session.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"version": "2.16.0",
"showSampleNames": false,
"sampleNameViewportWidth": 6,
"genome": "hg38",
"locus": "chr6:152,971,612-152,992,127",
"roi": [],
"sampleinfo": [
{
"type": "sampleinfo",
"url": "https://www.dropbox.com/s/oeg6y37mvyfjif3/sampleInfo.txt?dl=0"
}
],
"tracks": [
{
"url": "https://www.dropbox.com/scl/fi/9begjuwqq1kwhcbtnrioq/model2.allChr.f.2.hg38.r10-Yan-Hu.hic?rlkey=n94vc1qvlsn19fjocki9ereff&dl=0",
"filename": "model2.allChr.f.2.hg38.r10-Yan-Hu.hic",
"name": "m",
"order": 0,
"format": "hic",
"type": "shoebox",
"displayMode": "SQUISHED",
"height": 500,
"visibilityWindow": 1000000
}
]
}
Loading

0 comments on commit 4328437

Please sign in to comment.