sophistication
sophistication copied to clipboard
Overall Structure Visualization
For the documentation, it could be helpful to have an overview of the structure of the package in addition to the "How to use" portion of the README
.
It looks like there are a couple of work-streams and functions that go together (i.e. regular
vs. gold
). It could be nice to have a simple tree structure visualization that shows which functions go together and when the user will need to make choices in their workflow.
For example:
R
│ - data()
│ - snippets_make()
| - snippets_clean()
|
└─── pairs_make_x()
│ │ - pairs_regular_make()
│ │ - pairs_gold_make()
good choice for a vignette or "article", e.g. via pkgdown. See https://github.com/quanteda/quanteda for how to configure this.