Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jrobinso committed Jul 7, 2022
1 parent cacc7a4 commit e0a9e30
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,16 @@ igv_notebook.init()
For a Jupyter notebook this should be done once per notebook. Colab notebooks display output in a sandboxed iFrame
for each cell, so these steps must be repeated for each cell in which igv-notebook is used.


### Version

To verify the currently installed version (versions > 0.3.1 only)

```python
igv_notebook.version()
```


### Browser creation

The Browser initializer takes a configuration dictionary which is converted to JSON and passed to the igv.js
Expand All @@ -72,6 +82,8 @@ createBrowser function. The configuration options are described in the
**Example:**

```python
import igv_notebook
igv_notebook.init()
b = igv_notebook.Browser(
{
"genome": "hg19",
Expand Down
2 changes: 1 addition & 1 deletion examples/BamFiles_Notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -280,4 +280,4 @@
},
"nbformat": 4,
"nbformat_minor": 4
}
}

0 comments on commit e0a9e30

Please sign in to comment.