gaynorr / AlphaSimR

R package for breeding program simulations
https://gaynorr.github.io/AlphaSimR/
Other
43 stars 20 forks source link

Rename or alias setPheno() to simPheno() #152

Open gregorgorjanc opened 1 year ago

gregorgorjanc commented 1 year ago

Is your feature request related to a problem? Please describe.

I have now seen a couple of cases where users have been thinking that setPheno() will give them the same pheno, wich of course will not happen due to the random error.

Describe the solution you'd like

Maybe renaming (or aliasing) setPheno() to simPheno() would be more didactic approach?

Describe alternatives you've considered

By aliasing and suggesting use of simPheno() instead of setPheno() the older code would not break.

Additional context

We could then look into making simPheno() a generic function with various model extensions in the future ...