vallenderlab / MicrobiomeR

A comprehensive and customizable R package for microbiome analysis.
https://vallenderlab.github.io/MicrobiomeR/
MIT License
20 stars 4 forks source link

Update function names. #62

Closed grabear closed 5 years ago

grabear commented 5 years ago
sdhutchins commented 5 years ago

I think it comes down to a matter of how hard we want to try (or effort) on this issue lol

For sure, I think finding better or more descriptive verbs to help name functions is good. Ironically, I read about that this week (when I find the link I'll post it), but it was suggesting to keep function names shorter while naming them with verbs.

If you take a quick glance at the NAMESPACE files for metacoder and phyloseq...they also have some similar overused words like calc, parse, get. vegan on the other hand sticks with using a concept to define the function such as betadisper or betadiver. That may be worth investing in. create_pub_table could become just pub_table or df_to_table.

Ultimately, I'm open to changing anything that'll make our functions easier to remember. Using a verb doesn't have to be what we do.

sdhutchins commented 5 years ago

Ready to be closed?