krumsieklab / MoDentify

Phenotype-driven module identification based on multi-level networks, R package
6 stars 2 forks source link

[FEATURE] Man page for identifyModules() return value is vague. #8

Open lashmore opened 5 years ago

lashmore commented 5 years ago

As a new user, I am very confused how to interpret the output of the identifyModules() function. The return value in the man page says "a list of 4 elements" is returned. But this doesn't help much in how I should parse the information in this list - and I think there's actually only 3 elements in the list that are returned, anyway.

I would really benefit from a plotting function that takes the returned list from identifyModules() and shows me why I should care about the output of identifyModules. What does this tell me about my data? What do the node scores mean and how are they combined for a module-level score?

First time writing an issue for someone else's work, so I hope my format is okay!

krumsiek commented 5 years ago

Thanks for the input, we will look into this.