microbiome/mia

Harmonizing documentation

Closed this issue · 3 comments

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...

Use the "@inheritParams" roxygen functionality for this.

Please close after the PR is merged.