neurogenomics / rare_disease_celltyping

Code, data and results associated with the "Rare diseases cell-typing" project.
6 stars 0 forks source link

Improve function coding practices #32

Closed bschilder closed 1 year ago

bschilder commented 2 years ago

This is more of a personal preference, but i find it much easier to read functions when the arguments are separated by newlines.

Also, it's good practice to make all function arguments explicit, bc if the order of the args ever changes, the function won't break.

Lastly, it's not essential to for every single function, but I think including @examples for a greater proportion of functions would be helpful.

Screenshot 2021-08-24 at 13 59 29

bschilder commented 2 years ago

I'll make some these changes as I go along, but it would be great if you could do more of this moving forward @ovrhuman !

bobGSmith commented 2 years ago

Sure will do!

bschilder commented 1 year ago

Went through and added examples (and unit tests) for all exported functions in HPOExplorer and MultiEWCE