Skip to content

readme update to take into account function renaming #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Installing via [PIP](https://pip.pypa.io/en/stable/installing/) should install a

`tanglegram` exposes three functions:

1. `tanglegram.plot` plots a tanglegram (untangling optionally)
1. `tanglegram.tanglegram` plots a tanglegram (untangling optionally)
2. `tanglegram.entanglement` measures the entanglement between two linkages
3. `tanglegram.untangle` rotates dendrograms to minimize entanglement

Expand All @@ -55,15 +55,15 @@ mat2 = pd.DataFrame(data,
index=labelsB)

# Plot tanglegram
fig = tg.plot(mat1, mat2, sort=False)
fig = tg.tanglegram(mat1, mat2, sort=False)
plt.show()
```

<img src="https://user-images.githubusercontent.com/7161148/105351954-2ae19f80-5be5-11eb-9dad-2dd0fe83d44d.png" width="650">

```Python
# Plot again but this time try minimizing cross-over
fig = tg.plot(mat1, mat2, sort=True)
fig = tg.tanglegram(mat1, mat2, sort=True)
plt.show()
```

Expand All @@ -72,7 +72,7 @@ plt.show()
```Python
# Alternatively, you can also explicitly provide the edges to plot and untangle
# Note how in this case the labels don't have to match anymore
fig = tg.plot(mat1, mat2, sort=True, edges=[('A', 'A'), ('C', 'D')])
fig = tg.tanglegram(mat1, mat2, sort=True, edges=[('A', 'A'), ('C', 'D')])
plt.show()
```

Expand Down