mia icon indicating copy to clipboard operation
mia copied to clipboard

Harmonizing documentation

Open TuomasBorman opened this issue 1 year ago • 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...

TuomasBorman avatar Oct 05 '23 09:10 TuomasBorman

Use the "@inheritParams" roxygen functionality for this.

antagomir avatar Oct 10 '23 19:10 antagomir

ping #603

Daenarys8 avatar Jul 22 '24 13:07 Daenarys8

Please close after the PR is merged.

antagomir avatar Jul 22 '24 13:07 antagomir