write general documentation articles - Githubissues

Claudius-Appel / duflor.gui

GUI frontent for `duflor`-package

https://claudius-appel.github.io/duflor.gui/

MIT License

0 stars 0 forks source link

write general documentation articles #40

Closed Claudius-Appel closed 6 months ago

Claudius-Appel commented 6 months ago

~~- [ ] article required for future support: issues must be raised properly.~~ ~~- [ ] add link to this article within the manual-article~~

REQURIED ARTICLES:

basic documentation
- GUI user manual > duflor.gui (how to use GUI, where to look for any of the topics listed here.)
- general analysis workflow > duflor (get images > load > get pixel counts > validate counts > potentially subset counts > calculate areas > merge to df > save to csv)
- Raising issues > duflor, duflor.gui
- Requesting features > duflor, duflor.gui
- Installation guide - goes into README
  - suggested use of a separate R-project in combination with renv to properly ensure package reproducibility and ease of installation
advanced features
- parallelisation > duflor.gui (when to use/don't use, how to sensibly set up, limitations)
- cropping > duflor.gui (why doing so can reduce error-rate and reduces execution_time, limitations)
- limiting search-area of identifier-dot > duflor.gui (when to use, limitations)
- saving states (when to use, limitations)
  - for bug-reports
  - for setting frequent settings easily (e.g. by saving a state with configured settings, but no chosen input-directory)

articles are placed where they are most sensibly linked to how they can be used/established (designated as > package)