search

microbiome / mia

Microbiome analysis
https://microbiome.github.io/mia/
Artistic License 2.0
46 stars 25 forks source link

Harmonizing documentation #458

Open TuomasBorman opened 9 months ago

TuomasBorman commented 9 months ago

Package documentation is not harmonized. For example, we describe boolean parameters in the parameter description as "must be a single boolean value" and "must be TRUE or FALSE". I think these should be harmonized in addition to other documentation as well (including error messages). This would make the documentation more clear and make it easier to follow the documentation.

This issue affects all the packages: mia, miaViz, miaSim, MGnifyR...

antagomir commented 9 months ago

Use the "@inheritParams" roxygen functionality for this.