Shians/Glimma

Suggestion for glMDSplot Documentation

Opened this issue · 1 comments

Hi Shian,

Can the help pages for glMDSPlot.DGEList and glMDSPlot.default be merged into the one page. For a user, it seems that the only difference is in the definition of the x-argument. To get to these help pages, "?glMDSplot" takes me to the main page which doesn't tell me much about the function until I click onto glMDSPlot.DGEList or glMDSPlot.default. It would be more direct to bring up these (merged) help pages directly from "?glMDSplot".

I think by doing so, it may also help users when running "args(glMDSplot)". Currently, it doesn't tell me much about the arguments within the function. Ideally it'd serve as a reminder to what argument names are for labeling and groups, etc.

Thirdly, can you please add a legend to the groups and colors plotted?

Cheers,
Charity

I'll think about it, at the moment my help pages are styled after the predict function which gives basically no information about the specific due to the different methods available.

Legends could take a bit of effort, but it's somewhere on the roadmap.