Skip to content

Commit

Permalink
Minor documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
sap218 committed Jun 25, 2024
1 parent 2a45cf5 commit 084f742
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ script | description
`catch` | annotate corpus with key terms & generate wordcloud
`bite` | rank terms in order of importance & bar plot
`arise` | update ontology with new metadata
`eyes` | plot an ontology via hierarchical or tree format
`eyes` | plot an ontology via web or tree format

When combining these Jabberwocky functions, users can create an NLP workflow.

Expand Down
6 changes: 4 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,9 @@ Users can generate a wordcloud figure from the corpus.
### bite
Rank all words in a corpus in terms of importance (via the TF-IDF statistical technique).

One valuable parameter is being able to adjust input for TF-IDF so the technique measures multiple n-grams.
Users can request more than unigrams: bigrams, trigrams, and more.

Users can provide a list of words to remove from the corpus to avoid being weighted/measured - the `bandersnatch` output can be used here.

##### Output
Expand Down Expand Up @@ -111,8 +114,7 @@ This can be derived from the `bite` output (e.g. synonyms).
---

### eyes
Plot an ontology in web or tree style.

Plot an ontology in web or tree style.
By default, superclasses will have overlay text but users can choose whether to include for subclasses.

##### Output
Expand Down

0 comments on commit 084f742

Please sign in to comment.