Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: consistent names and terminology #229

Open
edkerk opened this issue Feb 22, 2023 · 1 comment
Open

chore: consistent names and terminology #229

edkerk opened this issue Feb 22, 2023 · 1 comment

Comments

@edkerk
Copy link
Member

edkerk commented Feb 22, 2023

With the intense development work over the last months, there is not always consistency on what kind of terminology is used. It is helpful to be consistent, and it is good to enforce this from the first GECKO3 release onwards.

Note that the example function names indicated below are after changing them to their new name.

Term Meaning / use Example
ecModel abbreviation of enzyme-constrained model
empty ecModel ecModel after makeEcModel, without kcat values
modelAdapter a model-specific version of ModelAdapter.m ecYeastGEMAdapter.m
kcatList structure that contains kcat information, can have multiple entries per reaction / enzyme / source output of fuzzyMatching, loadDLKcatOutput()
load...() function that reads a datafile into MATLAB loadEcModel()
save...() function that writes a datafile from MATLAB saveEcModel()
gather...() function that downloads data or places API calls to an online resource. The output of this might be a data file, data structure in MATLAB, or directly in an ecModel gatherMetSMILES()
fill...() function that downloads data or places API calls to an online resource fillKcat()
apply...() function that modifies an ecModel with information that it already contains. For instance: applyKcatConstraints takes the information from ecModel.ec.mw and ecModel.ec.kcat to modify ecModel.S.

Not all function names will be covered by this scheme. For instance fuzzyKcatMatching does not fit any of the categories. Or should we have dofuzzyKcatMatching? Or specify get...() to indicate a function that applies some analysis on the model and gives an output that is outside the model (in this case a kcatList)? Edit: Or should we just accept that for instance fuzzyKcatMatching is not covered by the scheme and keep it unchanged?

This list is not complete yet, feel free to add suggestions below.

@ae-tafur
Copy link
Collaborator

ae-tafur commented Feb 22, 2023

I thing get...() fits better . Then, following your example.

Term Meaning / use Example
get...() gives an output that is outside the model fuzzyKcatMatching()
update...() function that update a value calculate previously inside the model updatePoolSize()

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants