saezlab / MetaProViz

R-package to perform metabolomics pre-processing, differential metabolite analysis, metabolite clustering and custom visualisations.
https://saezlab.github.io/MetaProViz/
GNU General Public License v3.0
8 stars 0 forks source link

Syntax #7

Closed ChristinaSchmidt1 closed 1 year ago

ChristinaSchmidt1 commented 1 year ago

Lets try and use the same syntax everywhere. I already started to update it a bit.

  1. message(), warning() or stop() instead of print()
  2. Use message() within if statements and not generically above. Can explain in person if not clear.
  3. For references use: "REF: XXX et. al., Year, Journal, doi: XXX."
  4. Let's use british english: normalisation versus normalization
  5. Let's try and use the name of our package in front of our functions: metaprovizPreprocessing() instead of Preprocessing()
  6. Lets not load the libraries (apart from tidyverse), but use :: instead. So we just install the packages if they dont exist and afterwards we will specify the the library the functions we use originate from
  7. Lets change the outputfolder names and add "MetaProViz_" at the beginning of the folder names
dprymidis commented 1 year ago

For 5 and 7. We discussed about this, that it becomes redundant quickly.

Should we remove the MetaProViz from in front of every function? So if you call the function like this: MetaProViz::Preprocessing instead of: MetaProViz::MetaProVizPreprocessing.

Should we do the same from the output folders? So that its : MetaProViz_Results_data -> Preprocessing/DMA/Boxplots instead of: MetaProViz_Results_data -> MetaProViz_Preprocessing/ MetaProViz_DMA/ MetaProViz_Boxplots

ChristinaSchmidt1 commented 1 year ago

Yes! You are completely right and it will also shorten the pathes :) Please feel free to go ahead with those changes of the names and pathes.

ChristinaSchmidt1 commented 1 year ago

After revisirting this, I think we have done it in all the functions and for the rest (e.g. always having the same paramter names), we have independent issues open.