Skip to content

Commit ace4b50

Browse files
authored
Update README.md
1 parent bafbf8b commit ace4b50

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,19 @@ To install the ideogram R library, download the [zip file](https://github.com/a-
2121
```
2222
install.packages("ideogram-main.zip", type="source", repos=NULL)
2323
```
24+
## IBD Segment File
25+
The input IBD segment file containing IBD segment to be displayed on the ideogram widget can be either an IBIS IBD segment file (.seg) or a TRUFFLE segments file (.segment).
26+
27+
An example <b>IBIS segment</b> file (default file is usually headerless)<br/><br/>
28+
![Screenshot from 2022-09-16 14-33-30](https://user-images.githubusercontent.com/26285885/190651099-ba52fb6e-e7cb-4f34-afcc-2cd2fe89d7a3.png)
29+
<br/><br/>
30+
31+
If a header is provided, the header must be specified as follows:<br/><br/>
32+
![Screenshot from 2022-09-16 14-35-17](https://user-images.githubusercontent.com/26285885/190651492-ce765220-017f-49f2-8904-ce0aca71d07f.png)
33+
<br/><br/>
34+
35+
An example <b>Truffle segments</b> file (taken from an example provided on the TRUFFLE website at https://adimitromanolakis.github.io/truffle-website/documentation/doc.html)
36+
![image](https://user-images.githubusercontent.com/26285885/190647191-29a3bebd-dfb8-4341-867b-00e9ac211dbe.png)
2437

2538

2639
## Usage

0 commit comments

Comments
 (0)