search

SystemsGenetics / KINC

Knowledge Independent Network Construction
MIT License
11 stars 4 forks source link

Need consistency of what files are called #173

Open JohnHadish opened 4 years ago

JohnHadish commented 4 years ago

The current nomenclature for what files are called is not consistent between the documentation and qkinc. This needs to be checked out, as it is confusing for even someone who is familiar with the program. I think there are too many file types that consist of some combination of c's , m's, and x's. It gets really confusing to try to tell them apart.

It is probably not realistic to change the names this late in the game, but I think we can help clarify by making everything really consistent. To start out, every file type should always be referenced by its full name and its extension. This should be both in qkinc drop downs: image

and in documentation: image

In addition, a single name needs to be decided on for `cluster composition matrix / cluster parameter matrix / cluster matrix' and it needs to be very consistent across all documentation.

Right now it feels like a treasure hunt every time I want to refer to one of these file types. I would prefer that they be renamed with moreunique names, but I recognize that may not be possible at this point. At the very least, we need consistency in what we are calling these different files, as there is very little right now.

spficklin commented 4 years ago

Agreed. This is an easy fix.

bentsherman commented 3 years ago

These display names are defined in the data factory:

https://github.com/SystemsGenetics/KINC/blob/master/src/core/datafactory.cpp#L31

@JohnHadish I encourage you to submit a PR for this change since you only have to change the string values. No other code change is required.