Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fix docs #25

Merged
merged 2 commits into from
Nov 2, 2022
Merged

Fix docs #25

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a254f1
fix typo
banhbio Nov 1, 2022
dd5071b
fix doc
banhbio Nov 2, 2022
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
5 changes: 2 additions & 3 deletions docs/src/man/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Taxonomy.DB("db/nodes.dmp","db/names.dmp")

```julia
# Construct a Taxon from taxid and Taxonomy.DB
julia> human = Taxon(9606)
julia> human = Taxon(9606, db)
9606 [species] Homo sapiens

# Or, you can omit db from argument (current_db() loaded)
Expand Down Expand Up @@ -112,7 +112,7 @@ julia> print_tree(Taxon(9604))
├─ 46359 [subspecies] Gorilla beringei graueri
└─ 1159185 [subspecies] Gorilla beringei beringei
```
**Note:** Use the child-to-parent traverse as much as possible since the parent-to-child is very slow compared to the child-to-parent
**Note:** Use the child-to-parent traverse (`AbstrcatTrees.parent`) as much as possible since it is quite faster than parent-to-child traverse (`children` and iterators from `AbstractTrees.jl`).

## Find lowest common ancestor (LCA)
```julia
Expand All @@ -128,7 +128,6 @@ julia> lca([human, gorilla, orangutan])
9604 [family] Hominidae
```


## Evaluate ancestor/descendant relationships between two `Taxon`s
```julia
julia> viruses = Taxon(10239)
Expand Down