higlass-pileup 1.2.0 → 1.4.1

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+v1.4.0
+
+- When hovering over the coverage, the genomic range that is covered by the bar is now displayed
+- Added the option `minMappingQuality` which takes an integer. If this is set, reads with a mapping quality lower than the specified value are not displayed.
+- Added the option `outlineMateOnHover`
+- Added the option `highlightReadsBy` which is an array can contain one or more of the value `insertSize`, `pairOrientation`, `insertSizeAndPairOrientation`. Details in the docs.
+
+v1.3.1
+
+- Added GitHub releases workflow
+- Export PileupTrack as default
+
+v1.3.0
+
+- `maxTileWidth` option in the `data` section of the track that modifies the tile fetcher
+
 v1.2.0
 
 - Soft and hard clipped regions are now included in the calculation of an appropriate row for a read. Without that, clipped regions would often overlap with other reads

package/README.md

@@ -75,7 +75,12 @@ The live scripts can be found at:
             "data": {
               "type": "bam",
               "url": "https://pkerp.s3.amazonaws.com/public/bamfile_test/SRR1770413.sorted.bam",
-              "chromSizesUrl": "https://pkerp.s3.amazonaws.com/public/bamfile_test/GCF_000005845.2_ASM584v2_genomic.chrom.sizes"
+              "chromSizesUrl": "https://pkerp.s3.amazonaws.com/public/bamfile_test/GCF_000005845.2_ASM584v2_genomic.chrom.sizes",
+              {
+                "options": {
+                  "maxTileWidth": 30000
+                }
+              }
             },
             "width": 470
           }
@@ -100,6 +105,48 @@ The live scripts can be found at:
 - Navigate to higlass.io/app and drag the JSON file onto the viewer.
 - Browse away!
 
+## Options
+
+### Data config
+
+**maxTileWidth** - To limit the amount of data that is fetched from the server, HiGlass sets a
+default maximum tile width. This can be modified in the `data` section of the track config. Setting
+it to a large file will let you zoom out further while still fetching data. This is useful for
+viewing low coverage BAM files.
+
+### Track options
+
+**colorScale** - Array that controls the color of substitutions and highlighted reads. It can take 6 or 11 values. 11 values are required if you want to control highlighted read colors (see the `highlightReadsBy` option). Example:
+```
+"colorScale": [
+  "#2c7bb6", //color of A substitutions
+  "#92c5de", //color of T substitutions
+  "#ffffbf", //color of G substitutions
+  "#fdae61", //color of C substitutions
+  "#808080", //color of N substitutions
+  "#DCDCDC", //color of other substitutions
+  "#FF0000", //color of reads with large insert size
+  "#0000D1", //color of reads with small insert size
+  "#00D1D1", //color of reads with LL orientation (see https://software.broadinstitute.org/software/igv/interpreting_pair_orientations)
+  "#555CFA", //color of reads with RR orientation 
+  "#02A221", //color of reads with RL orientation 
+]
+```
+
+**outlineReadOnHover** - Highlights the current read on hover.
+
+**outlineMateOnHover** - Highlights the mate of the current read on hover. If the mate is a split read, 
+both alignments will be highlighted.
+
+**highlightReadsBy** - Array that can take the values `insertSize`, `pairOrientation` or `insertSizeAndPairOrientation`:
+- if `insertSize` is set, reads that have a large or small insert size will be highlighted. The thresholds are controlled by the `largeInsertSizeThreshold` and `smallInsertSizeThreshold` track options. `largeInsertSizeThreshold` defaults to `1000`, i.e., 1000 bp. `smallInsertSizeThreshold` is not set by default, i.e, reads with small insert size won't be highlighted.
+- if `pairOrientation` is set, reads with an abnormal mapping orientation are highlighted (e.g. ++,--,-+).
+- if `insertSizeAndPairOrientation` is set, reads with an abnormal mapping orientation that also have abnormal insert sizes are highlighted.
+- if multiple values are set, reads that fulfill any of the conditions are highlighed in the corresponding color.
+- highlight colors can be controlled by extending the `colorScale` track option to 11 values. The additional 5 values will control the large insert size color, small insert size color and the ++, --, -+ mapping orientations (in that order).
+
+**minMappingQuality** - If this is set (integer), reads with a mapping quality lower than the specified value are not displayed.
+
 ## Support
 
 For questions, please either open an issue or ask on the HiGlass Slack channel at http://bit.ly/higlass-slack